《Java 编程思想》003 Java注释和嵌入式文档

与您共读《Java 编程思想》 Page30~37

JDK中提供了javadoc，便于维护代码文档，可以进行代码注释的提取，输出一个HTML文件。

javadoc命令只能用在/***/的注释中出现。

• 使用方式
  
  • 嵌入式HTML
  • 文档标签
• 位置
  
  • @命令写在出”*”的最前面
  • 行内文档标签可以在任意地方，但在花括号内
• 类型
  
  • 类注释
  • 域注释
  • 方法注释
• 标签实例
  
  • @see classname 引入其它类，链接到其他文档
  • {@link package.class#member label} 类似于see，行内 label作为超链接
  • @docRoot 产生相对文档跟目录的相对路径
  • @inheritDoc 继承直接继承类的文档
  • @version
  • @author
  • @since 指定代码最早版本
  • @param
  • @return
  • @throws
  • @Deprecated 建议用户不在使用的旧的特性

《Java 编程思想》第一章对象导论、第二章一切皆对象读完。

第一章主要是背景性和补充性的资料。引入各种概念更好了帮助读者了解OOP思想。对于面向对象中的类和接口的抽象过程、继承和多态等基本概念做了清晰的阐述。第二章则阐述了Java一切皆对象的基本思想，讲解了Java的数据类型等概念，并提供简单的实例帮助读者了解Java的编程知识。