Verwenden von Maven-Eigenschaften in JavaDoc

Question

Ist es möglich, den Maven-Eigenschaftenumfang auf Javadocs mit Maven Javadoc Plugin zu erweitern? Z.B.

/** 
* My Awesome Class 
* @version ${project.version} 
**/ 

Answer 1

Putting Ich denke, du so versuchen. Dies ist zweistufiger Prozess: Zuerst ist die pom Eigenschaft in statisches Feld Zweitens lädt das statische Feld zu verwenden, um die javadoc Eigenschaft festlegen

ein app.properties in src/main/resources mit Inhalt erstellen wie dies

application.version=${project.version} 

dann ermöglichen maven Filterung wie dieser Code

<build> 
    <resources> 
     <resource> 
      <directory>src/main/resources</directory> 
      <filtering>true</filtering> 
     </resource> 
    </resources> 

In Anwendung nur Eigenschaften lesen

Datei

public class MVNLinksHolder{ 

public static String version = ""; 

public MVNLinksHolder(){ 
    ClassPathResource resource = new ClassPathResource("app.properties"); 
    Properties p = new Properties(); 
    InputStream inputStream = null; 
    try { 
     inputStream = resource.getInputStream(); 
     p.load(inputStream); 
     version = p.getProperty("application.version"); 
    } 
    catch (IOException e) { 
     LOGGER.error(e.getMessage(), e); 
    } 
    finally { 
     Closeables.closeQuietly(inputStream); 
    } 
} 
} 

verwenden sie dann die Version

/** 
* My Awesome Class 
* @version = {@value MVNLinksHolder#version} 
**/ 

einstellen

Answer 2

zeigen
String
die Zugriffsebene für Klassen und Mitglieder zeigen in der Javadocs fest. Mögliche Werte sind: public (zeigt nur öffentliche Klassen und Mitglieder) geschützt (zeigt nur öffentlichen und geschützten Klassen und Mitglieder) Paket (zeigt alle Klassen und Mitglieder markiert nicht privat) privat (zeigt alle Klassen und Mitglieder)

Der Standardwert ist: protected. Benutzereigenschaft ist: show.

https://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html

Versuchen zeigen die öffentliche