整体说明
缩进用空格,不使用tab
文件变量名命名规范化,大部分按前缀方式
程序编写要按模块化原则,能独立实现的,都放到一模块中,说明其功能和具体使用环境及要求即可
文档说明
文档说明不能缺少,其是进行维护、再扩展开发的重要指导文件
编写基本要求是:让人明白,有一定基础的人都能进行继续开发
对于功能模块,必须写清楚接口,以及示例程序编写
一模块文档示例 模块 XML数据访问.doc
测试说明
开发都需要测试,软件硬件都需要,测试需要形成测试报告
测试报告 常用要素 包括: 测试人 测试时间 测试平台/版本 测试型号/对象 测试目的 测试方法 测试内容
测试结果 (是否可发布 生产 合格等) 等项,对于具体的测试,做上两次后应形成一基本标准模板,测试
数据/记录和统计信息一般放在单独sheet中,测试报告中还可以包括:测试问题 测试风险 BUG判断等
doxygen使用规范
自动文档生产doxygen使用规范指导,进入查看详细内容
xxx测试报告.xlsx - 测试报告参考模板一 (12.769 KB)