三、deprecated javadoc 注释的作用 1. 提醒其他开发人员 通过使用deprecated javadoc 注释,我们可以明确地告诉其他开发人员哪些方法或类已经被弃用,不建议再使用。这样做有利于整个团队在开发过程中避免使用过期的代码,从而提高代码的质量和可维护性。 2. 提供替代方案 在deprecated javadoc 注释中,我们可以添加一些说明,...
@Deprecated:用于标明已经过时的方法或类,源码如下,关于@Documented稍后分析: @Documented @Retention(RetentionPolicy.RUNTIME) @Target(value={CONSTRUCTOR, FIELD, LOCAL_VARIABLE, METHOD, PACKAGE, PARAMETER, TYPE}) public @interface Deprecated { } 1. 2. 3. 4. 5. 依然是一种『标记式注解』,永久存在,可...
* 这是抛出异常的条件1(非必须),注意格式 * * @throws 注意如果方法还存在其他异常,可并列多个 */ public int test(int capacity){ if (capacity < 0) throw new IllegalArgumentException("Illegal initial capacity"); return capacity; } @deprecated用于指出一些旧特性已由改进的新特性所取代,建议用户不要...
@deprecated 指名一个过期的类或成员,表明该类或方法不建议使用 @deprecated description {@docRoot} 指明当前文档根目录的路径 Directory Path @exception 可能抛出异常的说明,一般用于方法注释 @exception exception-name explanation {@inheritDoc} 从直接父类继承的注释 Inherits a comment from the immediate surpercl...
* @deprecated As of JDK 1.1, replaced by * {@link #setBounds(int,int,int,int)} */ 三、 Java注释 HTML标签 * 表示标题 * <P> 表示段落 </P> * 表示换行 * 表示原格式 * 表示一些代码,具有代码样式,但是格式会换行 * 特殊字体,常用来表示一些类名等 四、 Java注释...
@Deprecated public static String toLanguageTag(Locale locale) { return locale.getLanguage() + (hasText(locale.getCountry()) ? "-" + locale.getCountry() : ""); } @see @see 既可以用来类上也可以用在方法上,表示可以参考的类或者方法 /** * @see java.net.URLDecoder#decode(String, String)...
The javadoc command moves deprecated-text ahead of the main description, placing it in italics and preceding it with a bold warning: Deprecated. This tag is valid in all documentation comments: overview, package, class, interface, constructor, method and field. The first sentence of deprecated ...
@deprecated @author 适用范围:类、接口级别。 意义作用:指定对包或者类做出巨大贡献的技术人员,方便后续组内沟通。 使用规则:可以标注0个或者多个,@author标记并不重要,因为在生成API规范时不包含@author标记,因此只有查看源代码的人才能看到它。如果作者不明,请使用“ unscribed”作为@author的参数。
* @deprecated说明方法或类不推荐使用,建议使用其他替代的方法或类 * @version文档的版本信息 * @author作者名 * @see关联的其他类或方法 * @since所支持的最低版本 * @serial字段的序列化说明 * @serialField字段的序列化说明,可包含多个 * @serialData自定义序列化数据的格式说明 * @inheritDoc继承父类的文档...
@deprecated 指出函數已淘汰。 以下是語法範例:@deprecateddescription。 說明是選用的,不過,它會指出功能已淘汰的原因,以及應使用哪些項目作為替代方案。 以下是註解中所使用 Javadoc 標籤的範例:// @deprecated此函數已淘汰。 如果要使用 Script 編輯器語法檢查特性,註解應該在函數定義的正上方。