package-info.java文件詳解

来源:http://www.cnblogs.com/jiangxinnju/archive/2016/01/20/5146768.html
-Advertisement-
Play Games

歡迎關註我的社交賬號: 博客園地址: http://www.cnblogs.com/jiangxinnju/p/4781259.html GitHub地址: https://github.com/jiangxincode 知乎地址: https://www.zhihu.com/people/jia....


歡迎關註我的社交賬號:

博客園地址: http://www.cnblogs.com/jiangxinnju/p/4781259.html
GitHub地址: https://github.com/jiangxincode
知乎地址: https://www.zhihu.com/people/jiangxinnju

pacakge-info.java介紹

pacakge-info.java是一個Java文件,可以添加到任何的Java源碼包中。pacakge-info.java的目標是提供一個包級的文檔說明或者是包級的註釋。

pacakge-info.java文件中,唯一要求包含的內容是包的聲明語句,比如:

package edu.jiangxin.tools;

包文檔

在Java 5之前,包級的文檔是package.html,是通過JavaDoc生成的。而在Java 5以上版本,包的描述以及相關的文檔都可以寫入pacakge-info.java文件,它也用於JavaDoc的生成。比如:

    /**
     * 常用工具包<br>
     * @author Jiangxin
     * @version 1.0
     *
     */
    package edu.jiangxin.tools;

上面的說明通過JavaDoc生成如下:

在添加package-info.java之後,部分IDE可以在代碼中進行提示,如下圖:

包註釋

註釋對於程式員來說非常重要,pacakge-info.java文件包含了包級的註釋。我們還可以使用ElementType來自定義註釋。

包註釋當然是ElementType.PACKAGE了,除此之外,還有:

    ElementType.TYPE (class, interface, enum) 
    ElementType.FIELD (instance variable) 
    ElementType.METHOD ElementType.PARAMETER 
    ElementType.CONSTRUCTOR 
    ElementType.LOCAL_VARIABLE 
    ElementType.ANNOTATION_TYPE

比如,想讓包中的所有類型過時(Deprecate),你可以註釋每一個單獨的類型(類、介面、枚舉等),如下所示:

    @DEPRECATED
    PUBLIC CLASS CONTACT {
    }

或者是可以在package-info.java包聲明文件中使用@Deprecated註釋,它可以讓包中的一切均過時。

    @Deprecated
    package edu.jiangxin.tools;

把package-info.java添加到包中

可以手動在包目錄下創建package-info.java文件,也可以通過Eclipse工具實現這一點。


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 指針是C語言的靈魂,我想對於一級指針大家應該都很熟悉,也經常用到:比如說對於字元串的處理,函數參數的“值,結果傳遞”等,對於二級指針或者多級指針,我想理解起來也是比較容易的,比如二級指針就是指向指針的指針.....n級指針就是....但是可能大家比較不容易理解的是,二級指針或者多級指針用在哪裡呢?怎...
  • /** * 遍歷list的方法 * @param args */ public static void main(String[] args) { List list = new ArrayList(); list.add("111"); ...
  • 對於初學者朋友,在OC指針指針修改對象屬性掌握起來一般問題不大的,但是要再來幾個"函數"和你"折騰"呢?哈哈!看看你又沒有中過槍吧!看下麵一段代碼:void test1(int newAge,double newHeight);void test2(Person *newP);void tes...
  • 1. Callable、Future、RunnableFuture、FutureTask的繼承關係 在多線程編程中,我們一般通過一個實現了Runnable介面的對象來創建一個線程,這個線程在內部會執行Runnable對象的run方法。如果說我們創建一個線程來完成某項工作,希望在完成以後該線程能夠返回...
  • 一、字典(dict) 1. 概述 字典是Python唯一的映射類型。 只能使用不可變的對象(比如字元串)來作為字典的鍵,但是可以把不可變或可變的對象作為字典的值。 鍵值對在字典中以這樣的方式標記:d = key1 : value1, key2 : value2 。註意它們的鍵/值...
  • 最近項目中用到瞭解析Execl表格的功能,在網上百度了一下自己寫了一個小Demo。由於項目中使用的是Execl2007,就是尾碼為.xlsx的,所以只研究瞭解析和創建Execl2007的文件,解析Execl2007和Execl2003有一定的區別,大家在解析的時候要註意。一下是Demo中用到的jar...
  • 一個java 知乎爬蟲程式,使用echart 做圖表展示
  • Swift中的閉包,就是Objective-C中的Block, 其實兩者是一個東西1.Closure變數的聲明 (1)Closure就是匿名函數,我們可以定義一個閉包變數,而這個閉包變數的類型就是我們上面介紹的“函數類型”。 定義一個閉包變數其實就是定義一個特定函數類型的變數,方式如下。 因為...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...