ICode9

精准搜索请尝试: 精确搜索
首页 > 其他分享> 文章详细

#代码规范制定

2021-03-05 21:03:45  阅读:193  来源: 互联网

标签:缩写 空格 代码 规范 单词 注释 操作符 命名 制定


目录

缩进

程序块要采用缩进风格编写,缩进的空格数为4个。
如果使用TAB键,要设置空格数为4格。

变量命名

使用正确的英文单词,可以让读者易于理解,力求简单清楚,避免使用引起误解的词汇和模糊的使人产生误解.
采用驼峰命名法
变量的命名采用“小驼峰法”,如:camelCase,即第一个单词全小写,后面单词首字母大写。

每行最多字符数

较长的语句(>80字符)要分成多行书写。

函数最大行

不超过120行

函数、类命名

函数的命名,使用英文单词尽量可以描述该函数主要功能,可采用(动-名)或者(谓-宾)的结构。
二者皆采用大驼峰命名法,即所有单词首字母都大写。

如下形式例外(领域模型的相关命名):
正例:MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion
反例:macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion

常量

常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌名字长。

空行规则

  1. 相对独立的程序块之间要使用空行分开;
  2. 变量声明应尽可能靠近第一次使用处,避免一次性声明一组没有马上使用的变量。
  3. 函数间要使用空行分开;
  4. 每个类声明之后应该加入空格同
    其他代码分开

注释规则

  1. 注释应与其描述的代码相近,对代码的注释应放在其上方或右方(对单条语句的
    注释)相邻位置,不可放在下面,如放于上方则需与其上面的代码用空行隔开。
  2. 注释要与内容有相同的缩排
  3. 注释要与上面无关的代码用空行隔开
  4. 变量与常量的注释放在其右方
  5. 在源文件头部应列出,生成日期、作者、代码的主要功能。

操作符前后空格

  1. 值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符,如“=”、“+=”、“>=”、“+”、“*”、“%”、“&&”、“||”、“<<”、“^”等二元操作符前后应当加空格。
  2. 一元操作符“!”、“~”、“++”、“--”、“&”等前后不加空格。
  3. 如“[]”、“.”、“->”这类操作符前后不加空格

其他规则

  1. 关于命名的缩写:

较短的单词可以通过去掉“元音”形成缩写;较长的单词可取单词头几个字母形成缩写;一些单词有公认的缩写,如:
temp 可缩写为 tmp ;
flag 可缩写为 flg ;
statistic 可缩写为 stat ;
increment 可缩写为 inc ;
message 可缩写为 msg ;

  1. 程序的分界符如“{ }”要独占一行。如:

for (...)
{
... // program code
}
if (...)
{
... // program code
}
void example_fun( void )
{
... // program code
}

  1. if、for、do、while、case、switch、default等语句自占一行,且if、for、do、while等语句的执行语句部分无论多少都要加括号{}。

标签:缩写,空格,代码,规范,单词,注释,操作符,命名,制定
来源: https://www.cnblogs.com/cj-whales/p/14488460.html

本站声明: 1. iCode9 技术分享网(下文简称本站)提供的所有内容,仅供技术学习、探讨和分享;
2. 关于本站的所有留言、评论、转载及引用,纯属内容发起人的个人观点,与本站观点和立场无关;
3. 关于本站的所有言论和文字,纯属内容发起人的个人观点,与本站观点和立场无关;
4. 本站文章均是网友提供,不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属;如您发现该文章侵犯了您的权益,可联系我们第一时间进行删除;
5. 本站为非盈利性的个人网站,所有内容不会用来进行牟利,也不会利用任何形式的广告来间接获益,纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

专注分享技术,共同学习,共同进步。侵权联系[81616952@qq.com]

Copyright (C)ICode9.com, All Rights Reserved.

ICode9版权所有