2008-09-15 5 views
43

Warum verwendet der standardmäßige IntelliJ-Javadoc-Standardklassenkommentar eine nicht standardmäßige Syntax? Anstatt eine Zeile mit "User: jstauffer" zu erstellen, könnte eine Zeile mit "@author jstauffer" erstellt werden. Die anderen Zeilen, die es erstellt (Datum und Uhrzeit), haben wahrscheinlich keine Javadoc-Syntax zu verwenden, aber warum nicht die Javadoc-Syntax verwenden, wenn sie verfügbar ist?Warum verwendet der standardmäßige IntelliJ-Javadoc-Standardklassenkommentar eine nicht standardmäßige Syntax?

Denn hier Bezug ist ein Beispiel:

/** 
* Created by IntelliJ IDEA. 
* User: jstauffer 
* Date: Nov 13, 2007 
* Time: 11:15:10 AM 
* To change this template use File | Settings | File Templates. 
*/
+0

Ich bin mir bewusst, dass der Standard geändert werden kann. Ich frage mich nur, ob es einen guten Grund gibt, warum man das für einen Standard wählen würde. –

Antwort

48

Ich bin nicht sicher, warum Idee nicht den standardmäßig @author Tag nicht verwendet.

Sie können dieses Verhalten jedoch ändern, indem Sie auf File -> Settings -> File Templates gehen und den Eintrag File Header im Register Includes bearbeiten.

Ab IDEA 14 ist es: File -> Settings -> Editor -> File and Code Templates -> Includes -> File Header

+7

In IDEA 14 ist dies Datei -> Einstellungen -> Editor -> Datei- und Codevorlagen -> Includes -> File Header. –

4

Die Standardeinstellung ist lesbar, verwendbar, aber haftet nicht an oder jeden Codierungsstandard vor.

Ich denke, der Grund, warum IntelliJ die Javadoc-Tags nicht standardmäßig verwendet, ist so, dass mögliche Interferenzen mit Codierungs/Javadoc-Standards vermieden werden, die in Entwicklungsgeschäften existieren könnten. Es sollte für den Benutzer offensichtlich sein, wenn der Standard zu etwas passenderem geändert werden muss.

Wo ich arbeite, ist die Verwendung von Autor-Tags aus verschiedenen Gründen abgeraten.

1

Es ist wahrscheinlich, dass das Header-Snippet, das Sie anzeigen, älter als javadoc ist und nur von einem Coding-Standarddokument, das wahrscheinlich für C++ geschrieben wurde, entlehnt wurde.

+0

Es scheint, dass das Unternehmen gegründet wurde, um eine Java IDE zu machen: http://www.jetbrains.com/company/jbstory.html –

+0

Mein Punkt ist, dass sie sich wahrscheinlich umgesehen haben und ein C++ Kodierungsstandards Dokument gefunden haben (vielleicht von einem früheren Job) , vielleicht von irgendwo online) und griff den Header davon. –

3

Da es sich um eine Standarddateivorlage handelt, die Sie in den Standard Ihrer Organisation oder Ihren Geschmack ändern sollten.

Meine beste Schätzung.

6

In AndroidStuido 1.0.2 auf Mac

Go in Einstellungen dann auf der linken Spanne Datei und Code-Vorlagen Nach Datei und Code-Templates auf der rechten Seite der Auswahl wählen Registerkarte wählen enthält Dateikopfzeile und ändern Sie Ihre Dateikopfzeile.