博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
程序注释
阅读量:6360 次
发布时间:2019-06-23

本文共 266 字,大约阅读时间需要 1 分钟。

1.注释的坏处

  注释阐述的行可能与代码执行的行为不一致。

2.要用到注释的地方

   法律声明;

  代码的意图;

   警告,;

  信息的注释;

  阐释,对方法的参数进行描述;

3.注释注意的地方

   写注释时,最好要把注释写清楚,能在一个地方就能把目的写明白。

   注释时只提供有用的信息

   不要出现位置标记。

   不要出现日志注释,该注释的信息应该交给版本控制器。

   不要出现注释的代码

   显而易见的地方就不要加注释

4.注释代码时,用/** 注释的句子 */

 

转载于:https://www.cnblogs.com/kejian/p/4944490.html

你可能感兴趣的文章
验证码识别——图形验证码
查看>>
css动画效果之transition(动画过渡效果属性)
查看>>
神经网络joone_engin模式识别示范,eclipse
查看>>
SqlServer定时备份数据库和定时杀死数据库死锁解决
查看>>
Python操作redis数据库
查看>>
冲刺 12.8
查看>>
charles抓包并分析问题
查看>>
Loom
查看>>
format格式化字符串
查看>>
Oracle锁表(LOCK TABLE语句)
查看>>
【原】iOS学习之Swift之语法2(精简版)
查看>>
kylin2.4.1订单案例详细构建流程
查看>>
一个页面从输入URL到页面加载显示完成,这个过程都发生了什么?
查看>>
JQuery使用post异步传值
查看>>
myecplise 添加svn插件
查看>>
libvirt监控
查看>>
S老师 破坏神学习
查看>>
06 执行计划
查看>>
webstorm使用帮助(转自http://my.oschina.net/longteng2013/blog/138010),另外有部分内容摘自其它人博客...
查看>>
Linux服务器部署系列之八—Sendmail篇
查看>>