JDK 12 Early Access Build 20 （ 2018/11/15 ）可用，可以用來試用新的Javadoc標簽{@systemProperty} 。 新的{@systemProperty} Javadoc標記在core-libs-dev郵件列表消息“ FYI：用于文檔系統屬性的新javadoc標記 ”中進行了討論，并且是針對JDK-5076751 [“ javadocs中所需的系統屬性文檔”]引入的。 。

{@systemPropery} Javadoc標記在其生成的輸出中將其內容顯示為普通文本，并使該內容可用于JDK 9引入的Javadoc搜索 。 該標簽旨在用于記錄應用程序的系統屬性 。

以下簡單類將用于演示新的JDK 12 Javadoc標簽{@systemProperty} ：

package dustin.examples.jdk12.properties;import static java.lang.System.out;/*** Class with sole purpose to illustrate JDK 12's* support for {@literal {@systemProperty}}.*/ public class PropertiesDemo {/*** {@systemProperty blog.title} can be specified to* provide a blog title.*/private final static String PROPERTY_NAME = "blog.title";public static void main(final String[] arguments){final String property = System.getProperty(PROPERTY_NAME);out.println("Property " + PROPERTY_NAME + ": " + property);} }

上面的代碼示例將{@systemProperty}應用于private屬性PROPERTY_NAME 。 因為該字段為private ，所以必須使用-private標志執行Javadoc工具，以為此字段生成文檔。

下一個屏幕快照演示了使用JDK 12 Early Access Build 12 （不支持{@systemProperty}包含的javadoc命令行工具為簡單類生成的文檔。

上一個屏幕快照中的紅色橢圓形表示{@systemProperty}標記在JDK的早期版本中未正確處理。 該標記的內容不會顯示，并且“搜索”功能與系統屬性名稱不匹配。

下一個屏幕快照展示了使用JDK 12 Early Access Build 20隨附的命令行javadoc為同一類生成的文檔。

上一個屏幕快照中的綠色橢圓形表示{@systemProperty}在OpenJDK JDK 12的Early Access Build 20中得到更好的支持。該標記的內容已正確顯示在Javadoc本身中，并且搜索功能現在與系統屬性名稱匹配。

{@systemProperty}可能使開發人員更容易在Javadoc生成的文檔中查找應用程序的系統屬性的相關描述。 前面的文章“ FYI：用于記錄系統屬性的新javadoc標記 ”討論了可以利用此標記的其他Javadoc增強功能。 可能的增強功能包括“列出所有系統屬性的'摘要頁面'”，添加“有關定義的'范圍'的信息”以及允許“ {@systemProperty}標記中包含簡短描述”，即“可以包含在搜索索引，AZ索引和摘要頁面中。”

引入{@systemProperty}的Jonathan Gibbons FYI郵件列表消息還闡明了建議的用法：

標簽應在哪里使用？ 該標記應在屬性的定義實例的文本中使用。 這是描述系統屬性的特征的地方，其中可能包括諸如以下信息：“屬性的用途是什么”，“如何設置和何時設置”，“可以對其進行修改”，等等。

在帶有JDK 12 Early Access Build 20的Javadoc工具中添加{@systemProperty}是一件很小的事情，但是它將使開發人員可以使其他開發人員更容易地訪問重要系統屬性的文檔。

翻譯自: https://www.javacodegeeks.com/2018/11/jdk-12-javadoc-tag-system-properties.html

總結

以上是生活随笔為你收集整理的系统属性的JDK 12 Javadoc标记的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。