Open CutieDeng opened 2 years ago
相关内容已经同步更新到 README 中。
/**
<br>
<p>
<p/>
<blockquote> ... </blockquote>
{@link package.class(#method/member variable)}
@see
@deprecated
以下是关于枚举类 Continent 的注释,仅供参考:
Continent
/** * 七大洲<br> * <p/> * * 一个包含了七大洲(亚洲、欧洲...)的枚举类。<br> * <p/> * * 调用 {@link Continent#valueOf(String)} 能够直接获得相应的枚举实例。<br> * 例如:<br> * <blockquote> * Continent africa = Continent.valueOf("AFRICA"); * </blockquote> * <p/> * * 调用该方法需要传递相关的对应的枚举实例全名,而不是缺省值、或者其他语言下的翻译。<br> * 如果尝试写出以下代码:<br> * <blockquote> * Continent 亚洲 = Continent.valueOf("亚洲"); * </blockquote> * 则会得到一个参数不合法的异常回馈:{@link IllegalArgumentException}. * <p/> * * 在 tool 包中提供了一个特殊的解释器实例 {@link tool.Explainer}, 它将提供重载的解释方法 {@link tool.Explainer#getName(Continent)} 用户获取对应语言下的实例解释。<br> * <p/> * * @see tool.Explainer */
新增三个特殊的关键字(identifier)对方法进行描述:构造器,更改器,访问器。
相关内容已经同步更新到 README 中。
在代码中,使用 JavaDoc 注释应遵循如下的规范:
/**
开头,以显式描述该类、方法、成员变量的作用,注释应当写在其解释的对象之前。<br>
, 以让支持 html 渲染的设备能够意识到这里进行了显示的换行声明。<p>
进行分段,笔者建议在段落结束时直接增加一段<p/>
进行分段。<blockquote> ... </blockquote>
增加代码样例以便于使用者增进理解,和增加字数。{@link package.class(#method/member variable)}
能够创建一个指向其他类、方法、属性的超链接,以便于调用者增进理解。@see
注解能够在注释的尾部增加一段参考说明,语义大概同一篇论文的参考文章条目。@deprecated
表示该方法不推荐使用,将在未来弃用。(这实际上是一种对过去作出承诺的背弃,请不要轻易做出这个决定。)以下是关于枚举类
Continent
的注释,仅供参考: