Coding Principle

1：代码注释规范

作用：方便个人阅读，方便grouper维护。

在代码开头，应该注视本文件的作用

在函数上部，注释输入，输出及函数功能

关键代码需要注释

在类上部，应该注释类的作用

 

2：日志规范

作用：开发中发现不可预知的问题，线上排错

日志分类，如nginx日志可简单分为access.log及error.log

日志级别，也如nginx日志可分为 debug, info, notice, warn, error, crit 

明确在此位置需要什么类型的日志，需要什么级别的日志

 

3：文档如何维护

开发文档：使用什么技术，实现了什么功能，系统的架构是什么（图，表，形象直观）

用户手册：怎样部署，怎样配置，怎样开始使用（“HELLO WORLD?”），怎样验证生效，怎样测试性能，相关术语说明，日志位置，权限相关， 文件读写

更新：版本新功能，做了哪些修改（全部）（不用每次都看整个文档）

 

4：命名规范

命名最好不要用一个字母或者两个字母

命名应该有实际的意义

命名不要用重复，特别是在类的函数中，重复的命名并不认为是语法错误(this->data, data)，所以在类中的命名重复导致的问题很难定位到