C'è un commento sul copyright in ogni file java, ma non so quale devo usare: /* */ o /** */?Devo usare/* */o/** */per il copyright nella parte superiore di un file java?
/*
* Copyright ...
*/
import java.util.*
...
o
/**
* Copyright ...
*/
import java.util.*
....
Questo piuttosto vecchio (circa 1999) Sun coding conventions documento suggerisce /* */.
Più specificamente, si suggerisce il seguente layout per il file di classe/interfaccia (s):
Beginning commenti
/*
* Classname
* Version information
* Date
* Copyright notice
*/
package e import dichiarazioniEsempio:
/*
* MyClass
*
* v1.0
*
* 2011-11-29
*
* This file is copyrighted in an awesome way.
*/
package com.example.mypackage;
import com.example.otherpackage;
/**
* Javadoc comments for the class.
*/
public class MyClass {
...
}
Se si utilizzano strumenti /** */ documentare catturerà così è meglio usarlo :)
Ho appena letto alcuni progetti open source Java, ha trovato tutti utilizzare /* */
Javadoc si riuniscono solo /** ... */ commenti se sono direttamente prima di qualsiasi dichiarazione da documentare. package (diverso da package-info.java) e le dichiarazioni import non sono documentate in ogni caso, quindi Javadoc non guarderà il commento in alcun modo.
Poiché non è rilevante per Javadoc, è possibile utilizzare anche la versione "meno pesante" /* ... */.
+1 [Ecco il riferimento alla documentazione] (http://docs.oracle.com/javase/6/docs/technotes/tools/windows/javadoc.html#comments) se si desidera aggiungerlo alla risposta. In particolare la sezione ** Posizionamento di commenti **, dove afferma: * "I commenti della documentazione sono riconosciuti solo se posti immediatamente prima della classe, dell'interfaccia, del costruttore, del metodo o delle dichiarazioni di campo" *. Identifica anche la discussione su questa domanda: * "Un errore comune è inserire un'istruzione' import' tra il commento della classe e la dichiarazione della classe.Evitare questo, poiché lo strumento Javadoc ignorerà il commento della classe. "* –
Questa è sempre la cosa giusta, però? Cosa succede se il copyright si applica solo al codice? Cosa succede se l'API Javadoc è autorizzata/protetta da copyright in modo diverso? –
Questo è in realtà non corretto per il codice di esempio indicato nella domanda. Vedi [risposta di Paŭlo] (http://stackoverflow.com/a/8323983/29995) e il mio commento su di esso. –
Javadoc non prenderà le cose prima di una dichiarazione di importazione come nell'esempio nella domanda. –