Warum ist package-info.java nützlich?

Wenn ich CheckStyle über mein Java-Projekt heißt es Missing package-info.java file. für einige Klassen, aber nicht alle von Ihnen. Ich kann nicht wirklich herausfinden, warum diese Meldung erscheint nur manchmal. Außerdem mein Projekt läuft einwandfrei ohne package-info.java.

Was bedeutet das package-info.java tun? Brauche ich wirklich es für meine Java-Projekte?

  • Sie können für die Dokumentation oder Kommentierung auf Paket-Ebene. Siehe diese Frage.
  • Ich bin ein fan von package-info.java die ganze Zeit, aber ich Frage mich, ob eine README-Datei.md ist besser geeignet in 2018
  • Neben package-info.java und die README-Datei.md von Git, es gibt die Möglichkeit, Confluene evtl. mit Zusatz von Jira tickets sowie. So auch Diagramme, workflows oder videos Hinzugefügt werden können.
  • Wussten Sie, dass Sie können auch schreiben Sie anderen code auch drin? Wie Klassen etc... Komisch!
InformationsquelleAutor Socrates | 2014-02-28
  1. 71

    Es wird verwendet, um generieren von javadocs für ein Paket.

    /**
* Domain classes used to produce .....
* <p>
* These classes contain the ......
* </p>
*
* @since 1.0
* @author somebody
* @version 1.0
*/
package com.domain;

    Generieren, die Paket-info für com.domain Paket:

    Beispiel Ergebnis: https://docs.oracle.com/javase/7/docs/api/java/awt/package-summary.html

    • sorry immer noch nicht klar, welches Teil du refere Example result ist es die readme-Datei.md ?
    • Link wurde aktualisiert.
    InformationsquelleAutor m-szalik
  2. 35

    Anmerkungen

    Ein weiterer guter Grund für die Verwendung von package-info.java ist das hinzufügen von Standard - Anmerkungen für den Einsatz von FindBugs. Zum Beispiel, wenn Sie setzen diese in Ihrem Paket-info-Datei:

    @DefaultAnnotation(NonNull.class)
package com.my.package;

    dann, wenn findbugs läuft auf den code in diesem Paket, alle Methoden und Felder sind davon ausgegangen, dass nicht-null-es sei denn, Sie versehen Sie Sie mit @CheckForNull. Das ist viel schöner und mehr kinderleicht als Entwickler hinzufügen @NonNull Anmerkungen zu jeder Methode und Feld.

    InformationsquelleAutor mdhirsch
  3. 8

    Nicht nur einige findbugs Annotationen, aber eine Menge von java-Annotationen in gemeinsamen Bibliotheken haben die java.lang.annotation.ElementType.PACKAGE geben, als eines der möglichen Werte Ihrer eigenen java.lang.annotation.Target annotation, z.B.:

    com.google.gwt.core.client.js.JsNamespace
com.querydsl.core.annotations.Config
com.sun.xml.bind.XmlAccessorFactory
groovy.transform.BaseScript
java.lang.Deprecated
javax.annotation.Generated
javax.xml.bind.annotation.XmlAccessorOrder
org.hibernate.annotations.TypeDef
net.sf.ehcache.pool.sizeof.annotations.IgnoreSizeOf
org.apache.hive.common.HiveVersionAnnotation
org.apache.wicket.authroles.authorization.strategies.role.annotations.AuthorizeAction
org.codehaus.commons.nullanalysis.NotNullByDefault
org.eclipse.persistence.oxm.annotations.XmlNameTransformer
org.glassfish.jersey.Beta
org.jgroups.annotations.Experimental

    und vieles mehr.

    Diese package-info.java - Datei würde die Datei, wo Sie können solche Anmerkungen (zusammen mit dem javadoc).

    InformationsquelleAutor Rene Mazala
  4. 5

    A package-info.java Datei ermöglicht das hinzufügen von javadoc zu dokumentieren, ein ganzes Paket. Sehen http://docs.oracle.com/javase/7/docs/api/java/applet/package-summary.html zum Beispiel.

    Wenn Sie kümmern sich nicht über fehlende Paket-Dokumentation, dann ignorieren Sie die Warnung oder deaktivieren der JavadocPackage überprüfen.

    InformationsquelleAutor JB Nizet
  5. 1

    Den package-info.java ist eine Java-Datei, die Hinzugefügt werden können, um beliebigen Java-Quelltext-Paket. Es wird verwendet, um info zu einem "Paket" - Ebene als pro seinen Namen.
    Es enthält die Dokumentation und Anmerkungen in das Paket verwendet.

    javadoc-Beispiel ist bereits in der Antwort, die unten Teil wird erklärt, wie es funktioniert incase Anmerkungen.

    Zum Beispiel, in der unten aufgeführten Datei wird verwendet, um "Ersatz" das auftreten von joda.Zeit.DateTime mit org.jadira.usertype.dateandtime.joda.PersistentDateTime

    @TypeDefs({
    @TypeDef(name = "PersistentDateTime", typeClass = PersistentDateTime.class, defaultForType=DateTime.class)})

package xyz.abc;

import org.hibernate.annotations.TypeDef;
import org.hibernate.annotations.TypeDefs;
import org.jadira.usertype.dateandtime.joda.PersistentDateTime;
import org.joda.time.DateTime;

    Gibt es eine Reihe von Anmerkungen zur Verfügung, mit denen kann verwendet werden, um verschiedene Dinge auf "Paket" - Ebene. Es finden sich unter https://docs.jboss.org/hibernate/orm/3.5/api/org/hibernate/annotations/package-summary.html

    InformationsquelleAutor subodhkarwa
Schreibe einen Kommentar