变量限定词
类似于total, sum, average, max, min, record, string, pointer 这样的限定词
请把限定词加到名字的最后
函数名称
- 描述了子程序做到所有事情
- 避免使用无意义的，模糊或表述不清的动词
- 根据需要确定子程序名字的长度
- 给函数命名时要对返回值有所描述
- 给过程起名时使用语气强烈的动词加宾语的形式
- 为常用操作确定命名规则
函数参数
- 把状态或出错变量放在最后
- 在接口中对参数的假定加以说明
代码注释
写注释的一个总的原则就是注释应该尽量用来表明作者的意图
推荐的写注释的过程是首先使用注释勾勒出代码的主要框架，然后根据注释撰写相应的代码。
下面是一些写注释时需要注意的要点：
- 避免对单独语句进行注释
- 通过注释解释为什么这么做、或者要做什么，使代码的读者可以只阅读注释理解代码
- 对读者可能会有疑问的地方进行注释
- 对数据定义进行注释，而不是对其使用过程进行注释
- 对于难于理解的代码，进行改写，而不要试图通过注释加以说明
- 对关键的控制结构进行注释
- 对数据和函数的边界、使用前提等进行注释
网友评论