Ajouter des descriptions de classe à un code?
Je suis en train de finir un projet, j'ai travaillé pendant un certain temps, et je suis juste de mettre sur la touche finale.
Une chose que je voudrais faire est d'ajouter des descriptions des classes en haut de chaque fichier de classe (pour m'aider et d'autres programmeurs de comprendre ce qui se passe). Ma pensée est de simplement utiliser un tas de " /"s à l'aide d'une corde un article pour moi d'écrire quelques notes, mais peut-être il ya une meilleure façon? Est-il intégré dans la façon de le faire dans Visual Studio?
/////////////////////////////////////////////////////
// //
//KillZombies.cs //
// //
//Description: This class contains blah blah blah //
// //
/////////////////////////////////////////////////////
source d'informationauteur sooprise
Vous devez vous connecter pour publier un commentaire.
Oui, vous devez utiliser la normale Documentation XML:
De cette façon, il s'affichera dans Intellisense, et si vous construisez votre documentation avec des Châteaux de sable/ndoc/Doxygen etc il apparaît de façon appropriée.
Si vous tapez "///" dans la ligne au-dessus de votre classe, vous devriez voir un modèle approprié pour commencer. Consultez le site web MSDN lien ci-dessus pour plus d'informations.
Utilisation Les commentaires de documentation XML:
Lorsque vous tapez les trois barres obliques, Visual Studio va vous aider avec le reste.
N'utilisez pas de fantaisie de la mise en forme ASCII parce que quand vous refactoriser de changer les noms de classe, vous aurez à passer des plombes à le reformatage de toutes vos boîtes pour faire leur line-up bien de nouveau.
Les commentaires de documentation XML décrit dans les réponses ci-dessus sont la voie à suivre pour la documentation des classes et des méthodes.
Si vous avez besoin d'informations supplémentaires dans chaque fichier pour les non-documentation de texte, telles que la date de création, les crédits, les droits d'auteur des messages, et ainsi de suite, vous pourriez ajouter un extrait de texte ou d'ajouter au modèle Visual Studio. VS a des variables pour les modèles comme $$ nom d'utilisateur et $temps$ qui peut être utilisé pour insérer automatiquement les valeurs à chaque fois que vous ajoutez un nouvel élément basé sur votre modèle.