代码要求
序号 要求 备注
1
有详尽的编码规范书，应包括
（1） 注释规范
（2） 书写规范（缩进换行，括号，关键字，控制语句）
（3） 命名规范（变量，函数，类名，常量，文件名等）
2 有详细的文件目录说明文档，具体说明每个代码文件的作用
3 代码整齐有序，符合第 1 项的编码规范
4 每个文件开头，有详细文件功能注释
5 每个函数前有详细的函数输入/输出/功能的注释
6 每个功能段代码有详细的代码注释
一、 目的
为了确保项目组的所有开发人员能够更好地协同工作，整个项目组可以生产出高质量的
代码，每个开发人员所完成的源代码应该反映出一致的风格，以提高源代码的可读性和
可维护性。
二、 阅读说明
遵守规则级别说明：
3：必须遵守规则。
2：除非有特殊情况，则应遵守规则。
1：建议采用。
三、 规范
（一）概述
编码方法合并了软件开发的许多方面。尽管它们通常对应用程序的功能没有影响，
但它
们对于改善对源代码的理解是有帮助的。这里考虑了所有形式的源代码，包括编程、脚
本撰写、标记和查询语言。
评论0
最新资源