共有三种类型的注释文档,分别对应于注释位置后面的三种元素:类、域和方法。
/** A class comment */ public class Documentation1 { /** A field comment */ public int i; /** A method comment */ public void f() {} }javadoc只能为public和protected成员进行文档注释。
2.8.3 嵌入式HTML /** * <pre> * System.out.println(new Date()); * </pre> */ public class Documentation2 { /** A field comment */ public int i; /** A method comment */ public void f() {} }javadoc输出文档如下:
2.8.4 一些标签示例略。
2.8.5 文档示例略。
2.9 编码风格在“Java编程语言编码约定”中,代码风格是这样规定的:
类名的首字母要大写,如果类名由几个单词构成,那么把它们并在一起(也就是说,不要用下划线来分隔名字),其中每个内部单词首字母都采用大写形式。
类名用“大驼峰”
方法、字段、对象引用名称用“小驼峰”