Java注释

好的注释可以方便程序设计者和程序阅读者读取，提高团队协作，便于后期维护。

Java注释有三种
1.单行注释：//..............
2.多行注释：/*...............*/
3.文档注释：/**...............*/

注释的位置

/**
一个类的注释
*/
public class docTest {
    /**
    一个变量的注释
     */
    public int i;
    /** 一个方法注释*/
    public void f(){
    //参数或者方法的注释
    
    }
}

类的注释

/**
 * 一句话功能描述
 * 功能详细描述
 * @author 标明开发该类模块的作者
 * @version 标明该类模块的版本
 * @see 参考转向，也就是相关主题。 查看相关内容，如类、方法、变量等。
 * @since 产品/模块版本。 API在什么程序的什么版本后开发支持
 * @deprecated 可选  标识随着程序版本的提升，当前API已经过期，仅为了保证兼容性依然存在，以此告之开发者不应再用这个API
 */

函数注释

/**
 * 一句话功能描述
 * 功能详细描述
 * @param 对方法中某参数的说明
 * @return 对方法返回值的说明
 * @exception 对方法可能抛出的异常进行说明
 */

另外，IDE工具可以自动生成文档，如eclipse