Existe-t-il un besoin de code avec le nom de l'auteur ajouté dans chaque fonction ou même les fichiers?Un code avec le nom de l'auteur est-il absolument nécessaire?
code Oui sera dans le contrôle de source et de nombreux programmeurs impliqués
Selon Code complet, les commentaires sont utilisés pour illustrer l'objectif du code. L'utiliser à d'autres fins peut entraîner un «déclin des commentaires». Cela dit, en gardant la trace de la propriété du code, change-log et qui modifie le fichier en dernier, IMHO, est le travail d'un repo de contrôle de source comme SVN, et ne devrait pas être dans les commentaires. Sauf si c'est une licence de toutes sortes. Ou utilisez le système de signets d'un EDI pour garder une trace de l'auteur d'une fonction et de la personne qui en est responsable.
Tout cela ne sont que mes 2 cents, cependant.
Si le code est sous contrôle de source, non.
Ce type de données doit être stocké dans le référentiel de code source.
Si le code est destiné à être largement distribué (dans un autre environnement sans aucun type de référentiel), alors oui, cela pourrait être utile. (Certaines sources java ne comprennent ce genre d'information, ainsi que le numéro de version à partir de laquelle une certaine évolution du code sont disponibles)
Il est évident que ce genre d'information (pour la base de code largement déployée) est le fichier niveau seulement.
Considérons par exemple le code source de java.lang.Boolean en Java:
/**
* [...]
* In addition, this class provides many methods for
* converting a {@code boolean} to a {@code String} and a
* {@code String} to a {@code boolean}, as well as other
* constants and methods useful when dealing with a
* {@code boolean}.
*
* @author Arthur van Hoff
* @version 1.60, 05/05/07
* @since JDK1.0
*/
public final class Boolean implements java.io.Serializable,
Comparable<Boolean> {
[...]
Vous n'avez pas tous les auteurs du début du temps, seul le plus récent, la dernière version majeure associée à la modification la plus récente , et la version pour l'introduction originale de la classe.
Cela peut aider pour API tooling par exemple, lorsque vous voulez maintenir de bonnes API.
Mais les informations sur l'auteur sont toujours limitées au fichier, pas aux fonctions: il représente le coordinateur ou le gestionnaire d'agrégation pour toutes les fonctions présentes dans la classe, même s'il y a eu plus d'un contributeur dans le temps.
En tant que tel, c'est une information publique, digne d'être mis explicitement dans le fichier, par opposition à une donnée méta-privé (qui écrit quoi), stocké comme tous les autres méta-données (date, version, branche, fusionner des informations, ...) dans un référentiel de code source.
Non. Vous ou l'entreprise pour laquelle vous travaillez avez implicitement des droits d'auteur. Mais cela étant dit à des fins de suivi, il peut être utile de demander à cette personne ce que ce code a fait plus tard.
C'est ce que SCC est pour ... –
Je ne suis pas sûr que les avis de droits d'auteur peuvent être placés dans les métadonnées. Mais la réponse de VonC est plus complète. –
oui c'est nécessaire. Si possible, donnez la date avec le nom. Il est utilisé à des fins de suivi et donne le privilège à d'autres de connaître le propriétaire de cette fonction.
Code Oui sera dans le contrôle source
Alors pas.Le contrôle de la source prend soin de suivre ceci (blame).
Spécialement pour les projets TeamSource OpenSource, il peut être utile ou nécessaire d'indiquer l'auteur d'un code particulier. Mais commenter chaque fonction semble vraiment excessif, d'autant plus que la plupart d'une classe sera écrite par le même auteur (n'est-ce pas?). J'aime la convention de bibliothèque de Java de spécifier l'auteur (s) pour chaque classe. D'une certaine manière, cela semble être le bon compromis. Sur le flipside, si vous avez co-écrit un cours, vous êtes responsable si quelqu'un d'autre écrit du code défectueux dedans. Je pense en fait que c'est une bonne chose . Une classe (dans OOP, au moins) est une entité de sorte que la qualité est déterminée par sa qualité globale. Si une fonction est mauvaise, c'est toute la classe.
Dans certains projets, les noms d'auteur peuvent être utilisés pour donner le crédit nécessaire à quelqu'un qui a mis plus d'effort dans le développement que prévu de lui. Une telle reconnaissance peut améliorer la motivation.
... pour * chaque fonction *? Combien d'auteurs a une classe? Et ne suffirait-il pas de les spécifier une fois, pour toute la classe? –
@Konrad: vrai, je parlais de la partie "même les fichiers" de la question de l'OP. Je n'ai pas vu cette information sur les fonctions. – VonC
Même dans les cas où cela est logique, les informations sur l'auteur et la version doivent être imprimées à l'aide de la fonction de mots-clés RCS du VCS utilisé. S'appuyer sur les ingénieurs pour maintenir cette information manuellement * conduira à des informations inexactes dans le fichier de commentaires. –