Java 基础入门随笔（9） JavaSE版——文档注释

上节中写了一些static变量以及静态的方法的定义使用以及与非静态的差别，这节补充下：

如果在一个类中所有方法都为静态的，且无成员变量，这时候需要对对应的类进行限制该类无法创建对象，具体操作如下：

private ArrayTool(){}

//该类中的方法都是静态的，所以该类是不需要的创建对象的。为了保证不让其他成创建该类对象，可以将该类的构造函数私有化。

1.文档注释

利用java虚假机中的javadoc工具进行文档注释生成，利用代码中的文档注释进行生成。

注意：

    1、每个编译单元（类文件）都仅能有一个public class
    2、public class的名称（包含大小写）必须和其类文件同名。
    3、一个类文件(*.java)中可以不存在public class。

使用 javadoc 标记：

javadoc 标记由"@"及其后所跟的标记类型和专用注释引用组成
javadoc 标记有如下一些：
@author 标明开发该类模块的作者
@version 标明该类模块的版本
@see 参考转向，也就是相关主题
@param 对方法中某参数的说明
@return 对方法返回值的说明
@exception 对方法可能抛出的异常进行说明

详情可参考Bluestorm's Space关于Javadoc注释的用法

 

 

 

转载于:https://www.cnblogs.com/Anand/p/4976417.html