紧放在变量、方法或类的声明之前的文档注释, 表示该注释应该被放在自动生成的文档中(由 javadoc 命令生成的 HTML 文件)以当作对声明项的描述。
在 javadoc 注释中加入一个以“@”开头的标记,结合 javadoc 指令的参数,可以在生成的 API 文档中产生特定的标记。
method──方法名应该是动词,大小写可混用,但首字母应小写。在每个方法名内,大写字母将词分隔并使用下划线。例如:
variables──所有变量都可大小写混用,但首字符应小写。词由大写字母分隔,用下划线,使用美元符号($),因为这个字符对内部类有特殊的含义。
control structures──当语句是控制结构的一部分时,即使是单个语句也应使用括号({})将语句封闭。例如:
blank── Java 程序中任何数量的空格都是允许的,但标识符中的空格使错误中,字符串中的空格是有效的。
comments──用注释来说明那些不明显的代码段落;对一般注释使用 // 分隔符, 而大段的代码可使用 /*···*/分隔符。使用 /**···*/将注释形成文档,并输入给 javadoc 以生成 HTML 代码文档。
推荐:
网友评论 ()条 查看