页脚Html代码

双人项目之代码规范

通过阅读与讨论,我与张辉制定如下代码规范:
总规则为简明、易懂、无歧义,尽量与未来职场要求接轨。
代码规范主要分为九个部分:
一、缩进
  在有层次关系的代码内,参照Python的强制缩进。同时考虑到在使用不同编辑器阅读程序时因为Tab键所设置的空格数量不一致造成排版不整齐,所以同一使用四个空格键进行缩进。
二、行宽
  大于80字符分成多行书写,长表达式要在低优先级操作符处 划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐, 语句可读
三、括号
  应该尽量地将每个运算表达式括起来,这样使的整个代码的可读性更加强。
四、断行与空白的{}行
  对于{}之间的内容应该单独占一行,这样可以使代码更加整洁。
五、分行
  做到一行一个语句,对于变量定义,则是应该能够见名知意。
六、命名
  做到见名之意,杜绝中文拼音
七、下划线

  不用于开头

八、大小写
  对于包,一律使用小写,对于类名一律使用Pascal命名法;对于函数与变量,均采用Camel命名法。
九、注释
  对于注释,按如下规范
/*
Author:liaohongsheng         CodedDate:2020-10-19 
ModifiedReason:              ModifyingDate:

Function name :max
Description   : Calculate the sum of Maximum subarray
Parameter     :
         arr       an initial array
         n         the length of the array
output        : None
return value  : the sum of Maximum subarray
*/
对每个函数的注释,为了阅读方便,写在函数开始之前。

posted @ 2020-10-19 22:16  180401廖红生  阅读(78)  评论(0)    收藏  举报