Java 的语法与C++ 及为相似，那么，你知道Java 的注释有几种吗？是两种？
// 注释一行
/* ...... */ 注释若干行
不完全对，除了以上两种之外，还有第三种，文档注释：
/** ...... */ 注释若干行，并写入javadoc 文档
1.注释要简单明了。
String userName = null; //用户名
2.边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。
3.在必要的地方注释，注释量要适中。注释的内容要清楚、明了，含义准确，防止注释二义性。保
持注释与其描述的代码相邻，即注释的就近原则。
4.对代码的注释应放在其上方相邻位置，不可放在下面。
对数据结构的注释应放在其上方相邻位置，
不可放在下面；对结构中的每个域的注释应放在此域的右方；
5.同一结构中不同域的注释要对齐。
6.变量、常量的注释应放在其上方相邻位置或右方。
7.全局变量要有较详细的注释，包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。
8.在每个源文件的头部要有必要的注释信息，包括：文件名；版本号；作者；生成日期；模块功能
描述（如功能、主要算法、内部各部分之间的关系、该文件与其它文件关系等）；主要函数或过程清
单及本文件历史修改记录等。
|
收藏
淘帖
踩
