java的注释规范（单行注释、多行注释、分块注释）
2星 需积分: 50 67 浏览量
2011-04-02
13:18:30
上传
评论 1
收藏 39KB DOC 举报 
注释规范 ¶
定义这个规范的目的是让项目中所有的文档都看起来像一个人写的，增加可读
性，减少项目组中因为换人而带来的损失。
注释通常有 2 种 ¶
1. 单行注释：
// 注释一行
2. 多行注释
/*
* 注释若干行
*/
在 Java 开发过程中，还包含了另一个注释方式，该方式可以生成 java doc.
/**
* java doc 注释
*/
3.分块注释
/********************************************************
* 模块说明
*******************************************************/
在 java 中，以模块来区分，进行归类注释。
在注释过程中应注意如下规则： ¶
1. 注释要简单明了。 如： String userName = null; //用户名
2. 边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的
一致性。
3. 在必要的地方注释，注释量要适中。注释的内容要清楚、明了，含义准
确，防止注释二义性。保持注释与其描述的代码相邻，即注释的就近原
则。
资源评论
大胖子哥2017-07-18不值得下载，就是网络上搜索的内容
facetothesea2012-03-09平心而论，2分也太高了吧，只有一个单行和多行注释，说明一下注释的好处，位置 我想查看的配置文件的注释也没有
