Le principe DRY (Don't Repeat Yourself) stipule que «chaque élément de connaissance doit avoir une représentation unique, non ambiguë et faisant autorité au sein d'un système». La plupart du temps, cela fait référence au code, mais il est souvent étendu à la documentation également. On dit que...
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 6 ans . l'objectif est d'avoir un système de...
Fermé . Cette question doit être plus ciblée . Il n'accepte pas actuellement les réponses. Voulez-vous améliorer cette question? Mettez à jour la question afin qu'elle se concentre sur un problème uniquement en modifiant ce message . Fermé il y a 4 ans . Je me suis toujours demandé comment trouver...
Après de nombreuses recherches, je n'ai pas réussi à répondre à une question de base concernant un supposé connu dans le monde du développement logiciel: CE QUI EST CONNU: L'application d'une politique stricte sur une documentation de code adéquate (que ce soit les balises Doxygen, Javadoc ou...
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 2 ans . Quelqu'un a-t-il déjà essayé de créer une...
Fermé . Cette question doit être plus ciblée . Il n'accepte pas actuellement les réponses. Voulez-vous améliorer cette question? Mettez à jour la question afin qu'elle se concentre sur un problème uniquement en modifiant ce message . Fermé il y a 5 ans . J'ai lu récemment quelques propositions de...
Je veux améliorer mes compétences en programmation en étudiant des projets open source célèbres, mais je trouve qu'il est facile de se perdre en sautant simplement dans leur code source. J'ai donc décidé de lire leur documentation sur leur conception ou leur architecture (comme les diagrammes UML)...
Fermé . Cette question doit être plus ciblée . Il n'accepte pas actuellement les réponses. Voulez-vous améliorer cette question? Mettez à jour la question afin qu'elle se concentre sur un problème uniquement en modifiant ce message . Fermé il y a 4 ans . J'ai terminé une application Web qui est...
À mon avis, les cas de tests unitaires servent eux-mêmes de documentation pour le code. Mon entreprise veut que j'écrive des commentaires détaillés sur le doc java sur les tests élémentaires. Est-il nécessaire de le faire? Écrivez-vous des commentaires comme
Parfois, il y a 1% de code suffisamment intensif en calcul qui nécessite le type d'optimisation de bas niveau le plus lourd. Les exemples sont le traitement vidéo, le traitement d'image et toutes sortes de traitement du signal, en général. Les objectifs sont de documenter et d'enseigner les...
J'ai un projet d'université auquel je ne vais pas commencer immédiatement, mais je réfléchis depuis assez longtemps. Je comprends que le développement de projets universitaires n'est pas comme l'industrie (je suis moi-même actuellement stagiaire), donc la situation que je vais signaler pour le...
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...
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
Fermé. Cette question est hors sujet . Il n'accepte pas actuellement les réponses. Voulez-vous améliorer cette question? Mettez à jour la question afin qu'elle soit sur le sujet pour Software Engineering Stack Exchange. Fermé il y a 6 ans . Je suis partisan de commenter le code source et de...
Je travaille actuellement sur mon diplôme pour mes études "Développement de logiciels", dans lesquelles je dois développer individuellement des logiciels complexes dans une entreprise externe. Tout cela doit être fait de manière structurée, en créant tous les documents correspondants. Pour ce...
Notre logiciel a plusieurs classes qui devraient être trouvées dynamiquement via la réflexion. Les classes ont toutes un constructeur avec une signature spécifique via laquelle le code de réflexion instancie les objets. Cependant, lorsque quelqu'un vérifie si la méthode est référencée (par exemple...
Il est difficile de dire ce qui est demandé ici. Cette question est ambiguë, vague, incomplète, trop large ou rhétorique et on ne peut raisonnablement y répondre sous sa forme actuelle. Pour obtenir de l'aide pour clarifier cette question afin qu'elle puisse être rouverte, visitez le centre d'aide...
Je fais partie de ces développeurs qui pensent que le code écrit doit être explicite et se lire comme un livre. TOUTEFOIS, lors du développement de code de bibliothèque pour d'autres personnes, j'essaie de mettre autant de documentation que possible dans les fichiers d'en-tête; ce qui soulève la...
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...
Là où je travaille actuellement, l'approche générale est - éviter autant que possible la documentation Documenter uniquement si une autre équipe en a besoin juste pour clarification, je ne parle pas de documentation de code - ce que nous faisons, je veux dire toute la documentation entourant le...