Java 编译器 Javadoc 首选项

指示 打开 Javadoc 首选项页 Java > 编译器 > Javadoc 首选项页上的 Javadoc 设置的首选项。

选项

描述

缺省

处理 Javadoc 注释(包括搜索和重构)

如果此选项处于启用状态,那么构建器将检测 Javadoc 注释中的问题。要使搜索和重构功能对 Javadoc 注释起作用,还需要启用此选项。

开

格式不正确的 Javadoc 注释

如果此选项处于启用状态,那么每当编译器遇到格式不正确的 Javadoc 注释时,它就会报告错误或发出警告。

忽略

仅考虑可视成员

编译器仅检查具有指定的可视性或更广可视性的成员。

公用

验证标记参数(@param、@throws、@exception、@see 和 @link)

如果此选项处于启用状态,那么每当编译器在 @param、@throws、@exception、@see 或 @link 的 Javadoc 注释标记参数中遇到错误时,它就会报告错误或发出警告。

关

报告非可视引用

如果此选项处于启用状态,那么每当编译器遇到对非可视元素的引用时,它就会报告错误或发出警告。

关

报告建议不要使用的引用

如果此选项处于启用状态,那么每当编译器遇到对建议不要使用的元素的引用时,它就会报告错误或发出警告。

关

缺少标记描述

请在“验证所有标准标记”、“验证 @return 标记”和“忽略”之间进行选择。如果此选项处于启用状态,那么每当编译器发现缺少标记描述时,它就会报告错误或发出警告。

“验证 @return 标记”

缺少 Javadoc 标记

如果此选项处于启用状态,那么每当编译器遇到缺少 Javadoc 标记(例如,参数缺少 @param 标记)的情况时,它就会报告错误或发出警告。

忽略

仅考虑可视成员

编译器仅检查具有指定的可视性或更广可视性的成员。

公用

在覆盖和实现方法中忽略

如果启用了此选项,那么不会检查用于覆盖或实现另一个方法的方法是否缺少 Javadoc 标记。

开

忽略方法类型参数

如果启用了此选项,那么不会对方法类型参数报告缺少 Javadoc 标记。

开

缺少 Javadoc 注释

如果此选项处于启用状态,那么每当编译器遇到 Java 成员缺少 Javadoc 注释的情况时,它就会报告错误或发出警告。

忽略

仅考虑可视成员

编译器仅检查具有指定的可视性或更广可视性的成员。

公用

在覆盖和实现方法中忽略

如果启用了此选项,那么不会检查用于覆盖或实现另一个方法的方法是否缺少 Javadoc 注释。

开