PHP/C/C++ - Wie sieht Ihre erste Kommentarblock in Ihren Programmen aussehen?

Question

Ich bin an einem großen Projekt und habe in meinem Programm noch keine Kommentare "Kopfzeilen" gemacht. Ich habe gerade angefangen, SVN für das Projekt zu verwenden. Ich möchte das SVN-Tag $ id $ hinzufügen, habe mich aber für keine Standardkommentare entschieden.

Also, meine Frage an alle hier ist, wie sieht Ihre erste Kommentarblock in all Ihren Programmen aussehen?

heißt:

/*************************************** 
* myProgram.c 
* revision: $id$ 
***************************************/ 

Answer 1

ich nicht eine solche verwenden. Ich brauche keinen.

Answer 2

Unternehmen vorformulierten Copyright + Datei Autor/Besitzer und ein Abschnitt kleiner Zwecks, wenn relevant (zB: wenn die Datei enthält eine Sammlung von kleinen verwandten Klassen mit Header ihrer eigenen)

Answer 3

Wenn ich einige Open bin Codierung Quellprogramm Ich füge normalerweise eine BSD-Lizenz hinzu, ansonsten gibt es keinen Standard-Header-Kommentar.

Answer 4

Es hängt davon ab, aber ich mag es nicht, wenn sie zu ausgefallen sind. So etwas ist genug für mich:

 
/* 
* file.c 
* 
* Description: 
* 
* History: 
* 
* 
*/ 

Alles komplexer nur lästig ist.

Answer 5

Werfen Sie einen Blick auf diese Fragen:

• Do you add information to the top of each .hpp/.cpp file?
• Are comment headers and footers in your code really necessary?
• Best Practice for comments in Java source files?

Answer 6

Ich persönlich benutze die gleichen Kommentare wie die javadoc diejenigen

/** 
* Your comment here 
*/ 

Answer 7

Jeder anfängliche Kommentarblock ist ein Platzmangel, wenn Sie eine Versionsverfolgungssoftware haben.