J'écris beaucoup de code (principalement c ++ et javascript) qui touche à la géométrie et aux graphiques de calcul et à ce genre de sujets, j'ai donc constaté que les diagrammes visuels étaient une partie indispensable du processus de résolution des problèmes. J'ai déterminé tout à l'heure que "oh,...
Considérez les marqueurs de conflit. c'est à dire: <<<<<<< branch blah blah this ======= blah blah that >>>>>>> HEAD Dans le cas particulier qui m'a motivé à poster cette question, le responsable de l'équipe venait de réaliser une fusion de l'amont vers...
Je recherche un format de documentation de classe informatif pour mes classes Entité, Logique d'entreprise et Accès aux données. J'ai trouvé deux formats d' ici Format 1 ///----------------------------------------------------------------- /// Namespace: <Class Namespace> /// Class: <Class...
Nous sommes en train de refactoriser une base de code héritée de 20 ans et j'ai une discussion avec mon collègue sur le format des commentaires dans le code (plsql, java). Il n'y a pas de format par défaut pour les commentaires, mais dans la plupart des cas, les gens font quelque chose comme ça...
Fermé . Cette question est basée sur l'opinion . Il n'accepte pas actuellement les réponses. Voulez-vous améliorer cette question? Mettez à jour la question afin d'y répondre avec des faits et des citations en modifiant ce message . Fermé il y a 4 ans . Pour les commentaires sur le contrôle de...
Est-il judicieux d'utiliser des variables locales supplémentaires, techniquement superflues, pour décrire ce qui se passe? Par exemple: bool easyUnderstandableIsTrue = (/* rather cryptic boolean expessions */); if(easyUnderstandableIsTrue) { // ... } En ce qui concerne les frais généraux...
J'ai une base de code privée assez importante qui a évolué depuis une dizaine d'années maintenant. Je n'utilise pas phpDocumentor mais depuis que l'utilisation des sections docblock est devenue tout à fait la norme dans les projets open source, j'ai également adopté l'écriture de docblocks pour...
Existe-t-il des pratiques courantes pour commenter les expressions régulières: commentaires en ligne faisant référence à différentes parties de RegEx ou commentaire général pour toutes les
Je travaille sur un projet "spaghetti-code", et pendant que je corrige des bugs et implémente de nouvelles fonctionnalités, je fais aussi quelques refactoring afin de rendre le code testable à l'unité. Le code est souvent si étroitement couplé ou compliqué que la correction d'un petit bug...
Je parlais avec un collègue aujourd'hui. Nous travaillons sur du code pour deux projets différents. Dans mon cas, je suis la seule personne à travailler sur mon code; dans son cas, plusieurs personnes travaillent sur la même base de code, y compris des étudiants coopératifs qui vont et viennent...
Lorsque j'écris de petits scripts pour moi-même, j'empile mon code avec des commentaires (parfois je commente plus que je code). Beaucoup de gens à qui je parle disent que je devrais documenter ces scripts, même s'ils sont personnels, de sorte que si je les vendais, je serais prêt. Mais les...
Je voudrais connaître la meilleure façon d'ajouter un commentaire pour identifier une classe obsolète en Java. Dois-je supprimer le commentaire précédent ajouté en haut de la classe qui aide un autre programmeur à savoir à quoi servait cette classe, ou dois-je l'ajouter sous le...
Est-ce une bonne pratique d'écrire des commentaires pour des méthodes largement connues comme equals, compareTo, etc.? Considérez le code ci-dessous. /** * This method compares the equality of the current object with the object of same type */ @Override public boolean equals(Object obj) { //code...
Je suis un partisan du code correctement documenté, et je suis bien conscient des inconvénients possibles de celui-ci . Cela sort du cadre de cette question. J'aime suivre la règle consistant à ajouter des commentaires XML pour chaque membre public, compte tenu de mon intérêt pour IntelliSense dans...
J'étais un fan d'exiger des commentaires XML pour la documentation. J'ai depuis changé d'avis pour deux raisons principales: Comme un bon code, les méthodes doivent être explicites. En pratique, la plupart des commentaires XML sont des bruits inutiles qui n'apportent aucune valeur supplémentaire....
C'est peut-être une question stupide, mais elle est à l'arrière de ma tête depuis un moment et je ne trouve aucune réponse décente ailleurs. J'ai un enseignant qui dit que nous devrions énumérer explicitement chaque paramètre avec une description, même s'il n'y en a qu'un. Cela conduit à beaucoup...
Dans l'état actuel des choses, cette question ne convient pas à notre format de questions / réponses. Nous nous attendons à ce que les réponses soient étayées par des faits, des références ou une expertise, mais cette question suscitera probablement un débat, des arguments, des sondages ou une...
Je veux écrire Javadoc de manière SECHE. Mais le document Oracle sur Javadoc dit à nouveau d'écrire la même chose dans le commentaire de la méthode de surcharge. Puis-je éviter la
Je lis Clean Code par Robert C. Martin, et la phrase TILTapparaît inexplicablement dans certains exemples de code. Exemple (c'est en Java, soit dit en passant): ... public String errorMessage() { switch (status) { case ErrorCode.OK: // TILT - Should not get here. return ""; case
Je suis sur le point de quitter un projet, et avant de partir, mon patron m'a demandé de documenter le code (je n'ai pas très bien documenté). Ce n'est pas grave, le projet n'est pas terriblement complexe. Mais je trouve des endroits dans ma documentation où je voudrais dire: "Remarquez en ligne...