写在前面:
- 一共三种注释:单行、多行、和文档。
- 注释内容写在要注释的元素前面。
- 普通注释(单行和多行)
- 单行注释是两个左斜线。
- 多行注释是/* */,编译的时候起止斜线之间的所有东西都会被忽略。
- 注释文档
- 注释内容写在要注释的元素前面。
- 这种注释可以生成文档。提取注释的工具:javadoc。(jdk的一部分,eclipse的“导出”选项中有,而且可以选择导出的注释等级,从privat到public不等,具体步骤在最后有)。
- -
- 嵌入式HTML
- 注释内容加上html标签,已达到html效果。(注意:不可以使用标题标签,如h1或者hr,因为javadoc会自己插入标题,可能导致冲突)
- 一些标签实例
- @auther
- @version
- @param parameter_name description
- @return description
- @throws fully-qulified–class-name description
- @Deprecated 过期的
实践:解决eclipse导出javadoc时的“错误: 编码GBK的不可映射字符”问题:
将-encoding UTF-8 -charset UTF-8这一段复制到elipse的相应输入框中,如下图: