Je recherche une recommandation de bonne pratique pour les commentaires XML en C #. Lorsque vous créez une propriété, il semble que la documentation XML attendue se présente sous la forme suivante: /// <summary> /// Gets or sets the ID the uniquely identifies this <see cref="User" /> instance. /// </summary> …
J'ai vu de nombreux numéros de problème à partir des commentaires du code jQuery . (En fait, il y avait 69 numéros de problème dans le code jQuery.) Je pense que ce serait une bonne pratique, mais je n'ai jamais vu de directives. S'il s'agit d'une bonne pratique, quelles sont …
Quelques-uns le font, mais aucun des plus populaires pour autant que je sache. Y a-t-il quelque chose de mal à imbriquer des commentaires? Je prévois d'avoir des commentaires de bloc imbriqués dans la (petite) langue sur laquelle je travaille, mais je voudrais savoir si c'est une mauvaise idée.
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 . J'ai souvent vu de tels …
Le développeur senior de notre boutique insiste sur le fait que chaque fois que le code est modifié, le programmeur responsable doit ajouter un commentaire en ligne indiquant ce qu'il a fait. Ces commentaires ressemblent généralement à// YYYY-MM-DD <User ID> Added this IF block per bug 1234. Nous utilisons TFS …
L'un des développeurs de mon équipe pense qu'il est nécessaire d'écrire un commentaire javadoc pour CHAQUE paramètre dans la signature d'une méthode. Je ne pense pas que cela soit nécessaire et, en fait, je pense que cela peut même être nocif. Tout d'abord, je pense que les noms de paramètres …
Dans une certaine base de code, vous pouvez voir des commentaires indiquant des choses comme: // Workaround for defect 'xxx', (See bug 1434594 on Sun's bugparade) J'ai donc quelques questions, mais elles sont toutes liées. Est-il correct de mettre un lien vers les questions SO dans les commentaires d'un programme: …
Est-ce considéré comme une mauvaise pratique de jeter NotImplementedExceptiondu code que vous n'avez pas encore écrit? Peut-être que les commentaires TODO seraient considérés comme plus sûrs?
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 . 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. …
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 notre agence, et dans certains cas les avait …
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, ne …
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 …
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 Name> /// Description: <Description> /// Author: <Author> Date: <DateTime> /// Notes: <Notes> /// Revision History: …
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 techniques, je m'attends à ce que le compilateur optimise cette ligne supplémentaire. …
We use cookies and other tracking technologies to improve your browsing experience on our website,
to show you personalized content and targeted ads, to analyze our website traffic,
and to understand where our visitors are coming from.
By continuing, you consent to our use of cookies and other tracking technologies and
affirm you're at least 16 years old or have consent from a parent or guardian.