Génie logiciel comments

11

Commentaires sur le contrôle de version - passé ou présent [fermé]

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 …

12 comments source-code

3

Les indices de type docblock sont-ils redondants lors de l'utilisation d'une frappe stricte

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 toutes les méthodes publiques …

12 php comments

2

La diffusion de code avec des commentaires de refactorisation est-elle une bonne idée?

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 entraînerait la réécriture de …

11 refactoring comments

8

Commenter des expressions régulières

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 expressions?

11 documentation coding-style comments

7

Les commentaires sont-ils meilleurs dans les environnements à fort taux de roulement?

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 assez …

11 coding-style team comments

1

Quelle est la meilleure façon de commenter une classe obsolète en Java?

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 commentaire?

11 java code-quality api comments

6

Les commentaires sont-ils considérés comme une forme de documentation?

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 …

11 documentation comments

3

Les commentaires XML sont-ils une documentation nécessaire?

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. Plusieurs fois, nous utilisons simplement GhostDoc pour …

10 .net programming-practices development-process documentation comments

5

Un commentaire de méthode doit-il inclure à la fois un résumé et une description de retour alors qu'ils sont souvent si similaires?

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 Visual Studio. …

10 documentation comments intellisense

7

Rédaction de documentation pour des méthodes bien comprises comme equals en Java

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 for equals } Mon entreprise …

10 java comments

1

Que signifie «TILT» dans un commentaire?

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 ErrorCode.UNEXPECTED_ARGUMENT: return "Unexpected argument"; …

9 java clean-code comments conventions

3

Comment faire référence à des domaines spécifiques du code dans la documentation?

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 …

9 documentation comments

2

Manière sèche d'écrire Javadoc sur les méthodes de surcharge

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 répétition?

9 documentation comments dry javadocs

8

Pourquoi tout le monde écrit-il des choses à faire en majuscules? [fermé]

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 discussion approfondie. …

9 comments

7

Commenter / Styles de documentation dans le code

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 de …

9 documentation comments coding-style

Questions marquées «comments»