有效提升代码可读性和质量的编码规范分享(一).docxVIP

  • 4
  • 0
  • 约1.27千字
  • 约 4页
  • 2017-05-10 发布于浙江
  • 举报

有效提升代码可读性和质量的编码规范分享(一).docx

有效提升代码可读性和质量的编码规范分享(一)

上一期分享什么是c语言编码规范,为什么要制定并遵守规范。这一期分享几则能立竿见影提升代码可读性和质量的规则。规则主要选自MISRA C规则和某为编码规范。 排版 代码字体设为等宽字体,代码字体设为等宽字体,代码字体设为等宽字体。嗯,重要的事情说三遍。Courier New字体是一个比较好的选择。 程序块要采用缩进风格编写,缩进的空格数为4个。当然也可以是2个或者3个,重点是必须是空格,不要用tab。代码编译器或者编辑器一般都会有将tab自动替换为n个空格的选项,即你仍然可以输入tab来缩进,编译器会自动用n个空格替换。以CCS5为例,设置方法如下 相对独立的程序块之间、变量说明之后必须加空行 例子: 若函数或过程中的参数较长,则要进行适当的划分, 以不超过80字符长度为参考原则 例子: if、for、do、while、case、switch、default等语句自占一行,且if、for、do、while等语句的执行语句部分无论多少都要加括号{} 注释 一般情况下,源程序有效注释量必须在20%以上 函数头部应进行注释,列出:函数的目的/功能、输入参数、输出参数、返回值、调用关系(函数、表)等。 边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。不再有用的注释要删除 注释格式尽量统一,建议使用“/*?……?*/” 标识符 标识符(内部的和外部的)的有效字符不能多于

文档评论(0)

1亿VIP精品文档

相关文档