Je me demande ce que devrait contenir une documentation d'algorithme? Impossible de trouver une ligne directrice appropriée à suivre. J'ai en tête d'inclure résumé de l'algorithme description de l'algorithme organigrammes pseudo codes exemple de jeu de données d'entrée (multiple) des données de...
Il me semble que vous ne pouvez pas écrire une spécification de logiciel en anglais qui soit complètement exempte d'ambiguïtés, simplement en raison de la nature informelle du langage naturel - et donc qu'une spécification vraiment sans ambiguïté doit inclure du code écrit dans une langue...
Une partie essentielle de la conception pilotée par le domaine est l'utilisation cohérente d'un langage omniprésent dans le système - dans les conversations, le code, le schéma de base de données, l'interface utilisateur, les tests, etc. Je participe à un projet dans lequel il existe déjà un...
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...
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 . L'équipe dont je fais partie fait...
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...
Nous utilisons actuellement des méthodes agiles dans mon projet actuel, et nous avons des tas d'histoires comme celles-ci: En tant qu'assistante, je veux rembourser un client afin qu'il puisse obtenir un peu d'argent quand il le demande En tant que client, je souhaite régler un achat afin de...
Nous créons une bibliothèque commerciale et des exemples de code qui sont utilisés par des développeurs externes. Nous avons une documentation (fermée, disponible pour les utilisateurs enregistrés) qui explique en détail comment utiliser la bibliothèque. Beaucoup de développeurs sont de nouveaux...
Je suis un développeur amateur et tous mes programmes jusqu'à présent étaient assez simples pour être documentés dans le code. En lisant le code, il était clair ce que je faisais telle ou telle action (mon test standard consistait à regarder le code 6 mois plus tard et à tout comprendre à la...
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....
J'ai documenté mon code pour doxygen, mais je ne veux pas le code HTML par défaut qu'il donne. Je sais que je peux le personnaliser en fournissant des CSS, des en-têtes, des pieds de page, etc. personnalisés (comme le fait GNOME), et comment je peux ajouter du code PHP commun aux fichiers et lui...
Quelles informations vous attendez-vous à voir dans le github README? Tout devrait-il aller dans le README? c'est à dire introduction Installation Versions Mode d'emploi la mise en oeuvre Essai Ressources associées Ou devriez-vous simplement mettre certaines choses dans le README (Introduction,...
Fermé . Cette question doit être plus ciblée . Il n'accepte pas actuellement les réponses. Vous souhaitez améliorer cette question? Mettez à jour la question pour qu'elle se concentre sur un seul problème en modifiant ce post . Fermé il y a 4 ans . Pourquoi incorporons-nous toujours des...
Je suis le seul développeur d'un projet qui, comme tout projet logiciel, pourrait être repris par quelqu'un d'autre à l'avenir. Disons que j'ai utilisé le modèle X pour implémenter la fonctionnalité A. Après avoir développé et terminé la fonctionnalité, je me rends compte que je pouvais implémenter...
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...
Vous corrigez donc des bogues, puis vous en avez rencontré un qui pourrait affecter d'autres modules du produit logiciel. Vos données ne sont pas suffisantes pour étayer votre affirmation concernant les effets du correctif et vous avez été invité à créer un document d'analyse d'impact. Existe-t-il...
J'accepte ma première application au niveau de l'entreprise et je veux que mon équipe modélise l'intégralité de l'application ASP.NET MVC C # avant même de taper une ligne de code. MISE À JOUR: Il ne s'agissait pas d'une discussion philosophique sur le moment de documenter / modéliser 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 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...
Cela fait référence à une discussion dans une réponse et aux commentaires de cette question: Quelle est l'aversion pour la documentation dans l'industrie? . La réponse affirmait que «le code ne peut pas mentir» et devrait donc être l'emplacement de référence au lieu de la documentation. Plusieurs...