代码规范

发表于 分类于 ， 阅读次数： 本文字数： 632 阅读时长 ≈ 1 分钟

代码规范

命名规范

  • 变量名
    首字母小写，其他单词首字母大写
    sum
    sumOfList
  • 函数名
    所有单词首字母大写
    Add()
    AddAllScore()
  • 文件名
    同函数名
  • 类名
    同函数名

注释规范

  • 文件文档
    文件开头应该包含以下注释内容
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    /*****************************
    @ FileName : //文件名
    @ Author ：//作者名字
    @ email：//作者邮箱
    @ date：//完成日期
    @ version：//版本

    @ Function List : //主要的函数列表，每条记录应包含函数名及其功能的简要描述
      1.
      2.
      ... 
    ******************************/
  • 变量名
    如果变量名不能直接看出其含义，因该在其上方或者右方编写注释
  • 函数文档
    用于说明函数的使用方式和功能

函数名下方因包含一下内容

1
2
3
4
5
6
7
/****************************
@ param param1:
@ param param2:

@ return :
@ other ：
****************************/

例如：
1
2
3
4
5
6
7
8
9
int Subtract(int a,int b){
  /*************************
  @ param a: 被减数
  @ param b: 减数
  @ return ：a-b的结果
  @ other ： 在int型数据范围内计算a-b的结果
  *************************/
  return a-b;
}