2010-08-29 7 views
0

Habituellement, beaucoup de gens contribuent au processus de développement d'une application (disons un projet java/j2ee). Parfois, une seule personne (par exemple, [email protected]) est responsable de l'écriture du code pour un certain fichier ou de certaines autres personnes pourraient avoir changé le code.Quelle est la règle générale pour attribuer un code à un auteur donné

Attribuez-vous des informations sur l'auteur en haut du fichier pour tout utilisateur effectuant une modification comme le scénario 2 mentionné ci-dessous ou uniquement l'auteur principal comme dans le scénario 1? Existe-t-il un ordre spécifique dans lequel les informations d'auteur doivent être ajoutées lors d'un changement?

/** 
* @author Foo Bar, ([email protected]) 
* 
*/ 

ou

/** 
* @author Foo Bar, ([email protected]) 
* @author Foo Foo, ([email protected]) 
* @author Bar Bar, ([email protected]) 
* 
*/ 

Répondre

4

Personnellement, je ne pense pas que les auteurs devraient être répertoriés dans le code. Il y a plusieurs raisons à cela:

  • Aucune revendication de "propriété". Le code est la responsabilité de tout le monde.
  • Le référentiel source peut répondre avec précision à n'importe quelle interrogation sur qui a édité le code en question depuis le premier jour (et j'espère même pourquoi). Pas besoin de maintenir cela manuellement.
0

Pour les projets en interne, je ne me baliser si mon travail représente un changement considérable ou est la première fois que la classe a été utilisé pendant un certain temps pour que mes collègues savent que je J'ai travaillé en classe et je le connais. À mon avis, chaque nouvel auteur devrait être ajouté à la liste.

Dans notre société, il s'agit vraiment de l'ingénieur individuel, nous n'avons pas de directives pour les balises d'auteur et parce que nous utilisons Fisheye, la vue source annotée qu'elle offre est une bien meilleure représentation de ce qui se passe.

Cela dépend vraiment de vos pilotes pour documenter les informations de création. Certainement l'architecte/ingénieur original devrait être noté et tous les auteurs importants puisque, s'il s'agissait d'un projet open source, vous voudriez probablement être plus strict à ce sujet. Ce sera intéressant de voir comment les autres abordent cela.