jdk 安全属性_系统属性的JDK 12 Javadoc标记
jdk 安全屬性
JDK 12 Early Access Build 20 ( 2018/11/15 )可用,可以用來試用新的Javadoc標簽{@systemProperty} 。 新的{@systemProperty} Javadoc標記在core-libs-dev郵件列表消息“ FYI:用于記錄系統(tǒng)屬性的新javadoc標記 ”中進行了討論,并且是針對JDK-5076751引入的 [“ javadocs中需要的系統(tǒng)屬性文檔”] 。
{@systemPropery} Javadoc標記在其生成的輸出中將其內(nèi)容顯示為普通文本,并使該內(nèi)容可用于JDK 9引入的Javadoc搜索 。 該標簽旨在用于記錄應(yīng)用程序的系統(tǒng)屬性 。
以下簡單類將用于演示新的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}應(yīng)用于private屬性PROPERTY_NAME 。 因為該字段為private ,所以必須使用-private標志執(zhí)行Javadoc工具,以為此字段生成文檔。
下一個屏幕快照演示了使用JDK 12 Early Access Build 12 (不支持{@systemProperty}包含的javadoc命令行工具為簡單類生成的文檔。
上一個屏幕快照中的紅色橢圓形表示{@systemProperty}標記在JDK的早期版本中未正確處理。 該標記的內(nèi)容不會顯示,并且“搜索”功能與系統(tǒng)屬性名稱不匹配。
下一個屏幕快照展示了使用JDK 12 Early Access Build 20隨附的命令行javadoc為同一類生成的文檔。
上一個屏幕快照中的綠色橢圓形表示OpenJDK JDK 12的Early Access Build 20中更好地支持{@systemProperty} 。該標簽的內(nèi)容已正確顯示在Javadoc本身中,并且搜索功能現(xiàn)在與系統(tǒng)屬性名稱匹配。
{@systemProperty}可能使開發(fā)人員更容易在Javadoc生成的文檔中找到應(yīng)用程序的系統(tǒng)屬性的相關(guān)描述。 前面的文章“ FYI:文檔系統(tǒng)屬性的新javadoc標記 ”討論了可以利用此標記的其他Javadoc增強功能。 潛在的增強功能包括“列出所有系統(tǒng)屬性的'摘要頁面'”,添加“有關(guān)定義的“范圍”的信息”以及允許“ {@systemProperty}標記中包含簡短描述”,“可以包含在搜索索引,AZ索引和摘要頁面中?!?
引入{@systemProperty}的Jonathan Gibbons FYI郵件列表消息還闡明了其推薦用法:
標簽應(yīng)在哪里使用? 該標記應(yīng)在屬性的定義實例的文本中使用。 這是描述系統(tǒng)屬性的特征的地方,其中可能包括諸如以下信息:“屬性的用途是什么”,“如何設(shè)置和何時設(shè)置”,“可以對其進行修改”,等等。
在帶有JDK 12 Early Access Build 20的Javadoc工具中添加{@systemProperty}是一件小事,但是它將使開發(fā)人員可以使其他開發(fā)人員更容易地訪問重要系統(tǒng)屬性的文檔。
翻譯自: https://www.javacodegeeks.com/2018/11/jdk-12-javadoc-tag-system-properties.html
jdk 安全屬性
總結(jié)
以上是生活随笔為你收集整理的jdk 安全属性_系统属性的JDK 12 Javadoc标记的全部內(nèi)容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 域名怎么投诉(如何投诉域名)
- 下一篇: 多云平台_多云系统的授权