每个工程师写程序的习惯和风格都不同，原本也没有什么对错，但我们是一个研发团队，绝对不能任由乱七八糟的程序代码充斥在系统中，正确性，可读性和可维护性一样重要，否则当某个“艺术派”软件工程师离职后，恐怕没有人具有一样的慧根可以改得动他的程序，在我们的团队中，所有软件工程师都必须遵守一份叫做“程序风格典范”的文件。所谓程序风格，不仅是命名规则而已，其中还规范了程序代码中至少应该具有哪些信息，以及程序写作的注意事项。
除了一些命名规则外，我们的写作程序必须注意的事项有以下几点：
1：该程序文件的用途描述；
2：撰写者与日期；
3：修改履历；
4：用特殊显眼的符号区分程序区段；
5：每一个function必须详述用途，各个参数的意义，返回值的意义；
6：每一个全局变量必须详述用途；
7：定义数据结构时必须详述每一个字段的意义；
8：尽可能多写批注，如果合作单位有外国人尽量写英文，但如果英文表达真的有问题，则宁愿用中文写：否则即使写了一堆批注，如果没人看得懂也是白写。
9：程序中的缩排必须整齐，最好用tab键，或规定缩排应该要空几个空格；
10：如果某一个循环（for and while loop)或条件式判断（if）的内容太长，则在结尾大括号（））的后面要加批注，说明这个循环或者条件式判断的内容；
11：不吝啬空行；
12：一个程序文件的行数不应该太多。
|
楼主
标题置顶
标题高亮
