1.注释的坏处
注释阐述的行可能与代码执行的行为不一致。
2.要用到注释的地方
法律声明;
代码的意图;
警告,;
信息的注释;
阐释,对方法的参数进行描述;
3.注释注意的地方
写注释时,最好要把注释写清楚,能在一个地方就能把目的写明白。
注释时只提供有用的信息
不要出现位置标记。
不要出现日志注释,该注释的信息应该交给版本控制器。
不要出现注释的代码
显而易见的地方就不要加注释
4.注释代码时,用/** 注释的句子 */
本文共 266 字,大约阅读时间需要 1 分钟。
1.注释的坏处
注释阐述的行可能与代码执行的行为不一致。
2.要用到注释的地方
法律声明;
代码的意图;
警告,;
信息的注释;
阐释,对方法的参数进行描述;
3.注释注意的地方
写注释时,最好要把注释写清楚,能在一个地方就能把目的写明白。
注释时只提供有用的信息
不要出现位置标记。
不要出现日志注释,该注释的信息应该交给版本控制器。
不要出现注释的代码
显而易见的地方就不要加注释
4.注释代码时,用/** 注释的句子 */
转载于:https://www.cnblogs.com/kejian/p/4944490.html