代码写及注释规范整理.pdfVIP

代码书写及注释规范 by wyp 一、有意义的命名 1、规范 驼峰法命名函数，单词命名变量，对变量作有意义的区分 2、避免误导 避开专有名词或容易引起混淆的字符，比如0和O、1和l 3、名称长短 名称长短与其作用域大小成正比： 作用域越大的变量，其表意越详细，可适时引入大写或下划线 二、注释 真正好的注释是你不用去写注释 注释不能美化糟糕的代码，与其美化糟糕代码的注释，不如去清洁代码 提供： 1、函数基本信息（不过尽量用函数命名取代此任务） 2、代码阐释 3、警示： 警示此段代码执行后可能得到的后果 4、对未实现功能的函数进行功能阐述 避免多余注释和误导性注释 5、少用位置标记 只对少数极重要位置进行该标记 过多使用该标记会使提醒变得不明显 6、注释掉的代码 注释掉的以后可能有用的代码，会像碎片一样堆在可用代码空间中，影响代码可读性。最好删掉。 个人做法如上图所示，将注释掉的代码后推，推至主代码区块外部，不影响有用代码的可读性即可。 三、格式 1、垂直格式 根据统计，一个系统所有文件的平均行数约200，最长一般500左右 你的目光总会停留在空白行之后的那行： 每个函数间、或有意义的区块间，留出空行以示区别 关系紧密的代码块之间靠的更近，反之要空出更大距离 函数间： 一般，被调用的函数要写在调用者的下面 函数或类中： 变量声明要放在函数或类的上部 2、横向格式 根据统计，一行字符最多一般为80个，最长不超过120个 赋值操作符附近加空格以示区别： 多参数用符号隔开时，符号后加空格以示区别： 高优先级运算变量间无空格，低优先级间的有空格 水平对齐： 作者觉得是无关紧要的，但看起来还是很爽的