javadoc规范、idea生成javadoc等

文章目录

• • • idea生成javadoc
    • • [idea生成javadoc时报错 编码GBK的不可映射字符](#idea生成javadoc时报错 编码GBK的不可映射字符)
      • 有哪些javadoc注解
    • 文档

以前不太注意这些规范，认为这个没用，写代码随心所欲，实际这个想法是不对的。

idea生成javadoc

可以给整个项目生成，也可以给某个文件生成。

点选某个文件 | tools | generate javadoc ，然后是一个弹出界面：

范围自定，可以是某个文件、也可以是整个项目、也可以是指定范围

注：导出的时候选个文件夹，因为javadoc是一系列文件，index.html以及文件夹等，不选文件夹会比较乱。

idea生成javadoc时报错 编码GBK的不可映射字符

other command line arguments添加如下参数即可：
-encoding utf-8 -charset utf-8

实测问题解决。

有哪些javadoc注解

@author‌：标识类或接口的作者。例如，@author 张三。‌
‌@version‌：指定类或接口的版本信息。例如，@version 1.0。‌
‌@param‌：描述方法的参数。格式为 @param 参数名 描述，如 @param n 第一个参数。‌
‌@return‌：描述方法的返回值。例如，@return 返回两个参数的和。‌
‌@throws 或 @exception‌：列出方法可能抛出的异常。例如，@throws IOException 输入输出异常。‌
‌@see‌：添加到其他主题（如类、方法）的链接。例如，@see Math#sqrt(double)。‌
‌@link‌：插入一个内联链接到另一个主题，支持自定义显示文本。例如，{@link String} 或 {@link String#length() length}。‌
‌@since‌：标记功能引入的版本。例如，@since 1.8。‌
‌@deprecated‌：标识过时的类、方法或字段，并提供替代建议。例如，@deprecated 使用新方法替代。‌
‌@serial‌：描述序列化属性。例如，@serial 用于持久化存储。‌
‌@serialData‌：描述通过 writeObject 或 writeExternal 方法写入的数据。‌
‌@serialField‌：描述 ObjectStreamField 组件的字段。‌
‌@inheritDoc‌：从直接父类继承注释内容。‌
‌{@docRoot}‌：指明文档根目录的路径。‌
‌{@value}‌：显示静态常量的值。例如，{@value MAX_SIZE}。‌
‌{@linkplain}‌：类似于 @link，但链接以纯文本字体显示。‌

文档

感觉不太用看文档，因为没什么难度。

https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html # oracle官网文档