java编写自定义类.docVIP

下面是编写自定义类的过程以及要注意的一些细节： 类文件是以文档注释开头的，其中包含对代码的基本描述以及作者信息和版本信息。 ????注释规范 ?????定义这个规范的目的是让项目中所有的文档都看起来像一个人写的，增加可读性，减少项目组中因为换人而带来的损失。（这些规范并不是一定要绝对遵守，但是一定要让程序有良好的可读性）。? ?????Java?的语法与?C++?及为相似，那么，你知道?Java?的注释有几种吗？是两种？?　　? //?注释一行　　 ?注释若干行 不完全对，除了以上两种之外，还有第三种，文档注释：?　　 ?注释若干行，并写入?javadoc?文档?注释要简单明了。 String?userName?=?null;?//用户名 边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。 在必要的地方注释，注释量要适中。注释的内容要清楚、明了，含义准确，防止注释二义性。保持注释与其描述的代码相邻，即注释的就近原则。 对代码的注释应放在其上方相邻位置，不可放在下面。对数据结构的注释应放在其上方相邻位置，不可放在下面；对结构中的每个域的注释应放在此域的右方；同一结构中不同域的注释要对齐。 变量、常量的注释应放在其上方相邻位置或右方。? 全局变量要有较详细的注释，包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。 在每个源文件的头部要有