Google 出品的 Java 编码规范和编程指南,权威又科学,强烈推荐(27)
Javadoc块的基本格式如下所示:
/** * Multiple lines of Javadoc text are written here * wrapped normally... */public int method(String p1) { ...
或者是以下单行形式:
/** An especially short bit of Javadoc. */
基本格式总是OK的 。 当整个Javadoc块能容纳于一行时(且没有Javadoc标记@XXX) , 可以使用单行形式 。
7.1.2 段落
空行(即 , 只包含最左侧星号的行)会出现在段落之间和Javadoc标记(@XXX)之前(如果有的话) 。 除了第一个段落 , 每个段落第一个单词前都有标签<p>
, 并且它和第一个单词间没有空格 。
7.1.3 Javadoc标记
标准的Javadoc标记按以下顺序出现:@param
@return
@throws
@deprecated
前面这4种标记如果出现 , 描述都不能为空 。 当描述无法在一行中容纳 , 连续行需要至少再缩进4个空格 。
推荐阅读
- 暴雪|错失DOTA一错再错?曾经的“暴雪出品,必属精品”为啥风光不再?
- 暗区突围|曾被称为“nc出品必属精品”的韩国大厂,如今遭遇三连跪
- 漫威银河护卫队|中日巅峰对决!日本Google Play年度最佳游戏提名,看点十足
- 明日方舟|游戏《明日方舟》决定动画化,由Yostar Pictures影业出品
- 手机游戏|拳头出品依旧值得信赖,英雄联盟手游复刻经典,皮肤可360度观看
- 仙女座|圣衣神话仙女座瞬重生版手办官图公开 万代出品的回锅肉真的不香
- 传统文化|周年庆即将来袭,对比2款周年庆皮肤,周年庆出品,必属精品
- 霰弹枪|剑与远征:废土出品并属精品,耀光终有可用大C!
- 我的世界|我的世界:Java种子新出炉,内陆蘑菇岛算什么,这些种子它不香?
- 暴雪|为何暴雪出品,已经不再是精品?(下)