JAVA 注释基本规范

1. 对于类/类属性/类方法,使用Javadoc规范,即/**content*/,Eclipse快捷键为Alt+Shift+J

2. 方法内部多行使用/*content*/,快捷键为Ctrl+Shift+C,只能将已有内容注释,无法注释空行; 方法内部单行使用//,快捷键为Ctrl+/

3. Javadoc规范注释

    1) 类:创建人,创建时间,类功能

    2) 方法:返回值,参数,异常说明,功能

4. 专有名词使用英文,其他注释重要的是解释清楚

5. 如代码发生修改,则需要修改对应的注释



猜你喜欢

转载自blog.csdn.net/weixin_42129080/article/details/80652554