首页 > 代码库 > Java基础——注释规范
Java基础——注释规范
一、注释格式分类:
1、单行(single-line)注释://……
2、块(block)注释:/*……*/
3、文档注释:/**……*/
javadoc有如下:
二、加注释的场景:
1. 基本注释(必须加)
(a)类(接口)的注释
(b)构造函数的注释
(c)方法的注释
(d)全局变量的注释
(e)字段/属性的注释
2. 特殊必须加注释(必须加)
(a)典型算法 必须有注释。
(b)在代码不明晰处必须有注释。
(c)在代码修改处加上修改标识的注释。
(d)在循环和逻辑分支组成的代码中加注释。
(e)为他人提供的接口必须加详细注释。
三、注释示例
类的注释
/**
* 测试类
* @author jiangbei01
* @version 1.0
*
*
*/
public class Test01 {
字段属性注释
private String username;//用户名,字段属性注释
全局变量注释
/**统计次数*/
private final int count= 18;
方法注释
/**
* 测试方法
* @param n 循环次数
*
*/
@Test
public void fun1(int n){
Java基础——注释规范
声明:以上内容来自用户投稿及互联网公开渠道收集整理发布,本网站不拥有所有权,未作人工编辑处理,也不承担相关法律责任,若内容有误或涉及侵权可进行投诉: 投诉/举报 工作人员会在5个工作日内联系你,一经查实,本站将立刻删除涉嫌侵权内容。