类的注释

方法

/**
    * 类说明
 */

示例

项目中任意类，如DocBase。

方法的注释

方法

    /**
        * 方法说明
        *
        * @param 参数类型 参数名称
        *
        * @return 返回值类型
     */

示例

DocInterface，其中的setName方法。

有用的技巧

文档继承

当某个类继承父类或实现接口，那么其中重新实现的同名方法的注释，可以使用父类或接口中的注释。

方法

    /**
        * {@inheritdoc} 固定使用这个标记
     */

示例

DocDemo类中的setName等方法。