首页  >   经验  >   编程规范实践总结-注释篇

编程规范实践总结-注释篇

查看 codexia 的博客 2015-06-24 16:15:02 1225
编程   规范  
手机阅读 | 转发赚积分
手机收藏 | 分享给好友
简介本文写的规范是个人大量编写代码,以及维护他人代码遇见各种问题而总结的代码注释方面的总结。

意义:

    可以极大提高程序稳定性,提高程序可维护性,提高程序快速维护效率,降低维护成本。有清晰的注释,可以快速定位代码,调试,也可以避免记忆错乱导致逻辑出错。好的注释,可以降低后期增加功能带来新问题的几率。

0.注释原则:简洁 清晰 逻辑

简洁表示注释不要太长,占篇幅,视觉不好
清晰是要使用合适的方式注释,配合排版,保持整齐美观
逻辑表示注释中可以快速看清逻辑,使用自己熟悉的语言写注释


1.固定的注释风格,可以使自己永远清晰注释所解释的代码。
注释一时解释下面的代码,一时解释上面的代码,一时解释左侧的一行代码,一时解释下面的所有代码,从而容易造成混淆,导致程序逻辑不能从注释中轻易看出。只要确定一个即可。
我的注释风格:
代码前:/* - 此条注释是解释以下的代码,到一下条注释为止 - */
代码右侧:// - 此条注释只解释左侧的一行代码
函数整体


2.注释要看得到逻辑流程,而不是具体的一句代码的意思

1.微信扫码
2.点击按钮,粘贴命令
自动刷新 手动刷新
命令:rd 1PET4i 复制
提示:如果您发送了命令,自动刷新会展开全文。自动刷新最多60秒,超过60秒请点击手动刷新。
创作不易,汗水不止!为防止劳动果实被爬虫窃取,开启了反爬机制,需要您发送命令继续阅读。取关会再次出现此提示。一段时间后出现此提示,请再次发送即可。如有问题,请加客服微信Freeme007处理。感谢您的理解。
标注
评论
站内搜
百度搜
传送到手机
手机扫码,识别文字,完成传送x
加载中...
标注内容x
加载中...
添加标注x
文章标题:编程规范实践总结-注释篇
文章地址:http://www.cjjjs.com/article/624201521516585
转载到个人博客,请在文末带上右侧内容(含超链接):本文转载自:编程规范实践总结-注释篇
收藏 0 点赞 0
公众号
微信赞赏
支付宝赞赏
领支付宝大红包
QQ群

相关阅读

  1. C++ Primer Plus 6th 6.11 编程练习题 第7题 统计单词的元音和辅音等的个数 查找全网同类文章
  2. C++ Primer Plus 6th 6.11 编程练习题 第6题 记录捐款姓名和捐款数额 查找全网同类文章
  3. C++ Primer Plus 6th 6.11 编程练习题 第5题 个人所得税计算 查找全网同类文章
  4. C++ Primer Plus 6th 6.11 编程练习题 第4题 菜单选择显示BOP的成员 查找全网同类文章
  5. C++ Primer Plus 6th 6.11 编程练习题 第3题 编写一个菜单驱动程序的雏形 查找全网同类文章
  6. C++ Primer Plus 6th 6.11 编程练习题 第2题 循环读取double并统计数据 查找全网同类文章
  7. C++ Primer Plus 6th 6.11 编程练习题 第1题 字符的大小写转换和回显字符 查找全网同类文章
  8. C++ Primer Plus 6th 5.9 编程练习题 第10题 分多行打印点号和星号 查找全网同类文章
  9. C++ Primer Plus 6th 5.9 编程练习题 第9题 使用string对象统计单词 查找全网同类文章
  10. C++ Primer Plus 6th 5.9 编程练习题 第8题 统计单词数,用done做结束识别 查找全网同类文章
分享到:

相关阅读

猜您感兴趣