Comment rapidement documenter le code du .NET Framework


Avez-vous besoin de documenter le .NET Framework C # ou VB.NET code source?

Alors que vous pourriez faire à la main, il vaut mieux investir dans un utilitaire appelé la documentation outil .NET. Ce petit outil pratique documenter rapidement tout le code pour vous, vous laissant avec le temps à consacrer à des tâches moins pénibles.

Le code documentée .NET Documentation Tool crée automatiquement la documentation de code source dans différents formats:

  • HTML est utile pour la saisie d'un code source de référence à la documentation de base de données à la main sur l'intranet de votre client ou de votre entreprise. Le code source est entièrement codés par couleur en utilisant un schéma de couleur similaire à celle utilisée par Visual Studio.
  • Aide format HTML est le format standard de fichier d'aide Microsoft Windows et permet au .NET de documentation de l'application pour être contenue dans un seul fichier. la documentation de base de données produite par le HTML Help Documentation Tool NET a également une belle indice d'entités de code, tels que les méthodes et les classes, et est également entièrement consultable!
  • Microsoft Word/RTF Format de documentation de base de données est idéale pour l'impression et de montrer vos supérieurs hiérarchiques!
  • Documentation en format texte peut être la base d'autres documents que vous pouvez être dit d'écrire pour une application.

applications .NET Documentation .NET

Être cours en classe, il est utile d'être en mesure de documenter les classes d'une application, ainsi que les méthodes (fonctions et sous-programmes), des recenseurs et des biens au sein de cette classe.

La meilleure caractéristique de .NET Framework à partir d'un point de vue de la documentation est l'occasion de faire des commentaires XML en C # ou VB.NET code source. Ces commentaires sont extraites de la documentation instrument de .NET et inclus dans le filet de la documentation du projet.




Ce est un grand avantage de .NET, comme si l'équipe de développement intègre des commentaires directement dans votre code, alors la question devient presque la documentation de soi. Gardez la documentation en ligne avec le code signifie également que l'équipe de développement peut facilement conserver la documentation à jour.

La Documentation instrument de .NET documentera tout projet .NET, des bibliothèques des applications graphiques et de la console de classe autonome Windows.

applications Web ASP.NET Documentation

La documentation instrument de .NET a un support supplémentaire pour ASP.NET. Soutien ASP.NET prévoit la reconnaissance des pages maîtres (de .master), Contrôles utilisateur (.ascx), contrôles Web, web.config, Fichier inclus JavaScript (JS), Cascading Style Sheets (.css), Handlers web (. ASHx) et le fichier du service Web (.asmx). variables d'application et de session sont identifiés dans le code.

Ainsi que le .NET C # ou VB.NET code source, la documentation de .NET peut également documenter les bases de données SQL Server ou Microsoft Access associés à une application .NET. La documentation peut alors visualiser les tables, vues, procédures stockées et associées à une demande. Pour la documentation de la base de données dédiée SQL Server, un outil pour SQL documentation est également disponible.

Si vous avez encore des sites ASP classique, puis un outil de documentation pour ASP ASP classique est également disponible.

Donc, si vous voulez économiser votre temps précieux alors lui donner un aller .NET documentation de l'outil (une version d'essai gratuite est disponible pour le téléchargement).

  • Documentation utilisateur Outils de fin pour la création de la documentation importante utilisateur - Info Barrel
    Outils pour la rédaction de la documentation de l'utilisateur final supérieure.
  • .NET Documentation Tool
    Documentor automatique de code pour le .NET Framework
  • Logiciel Portail de ressources de documentation
    Ressources pour documenter logiciels outils, les services publics et services

(0)
(0)

Commentaires - 0

Sans commentaires

Ajouter un commentaire

smile smile smile smile smile smile smile smile
smile smile smile smile smile smile smile smile
smile smile smile smile smile smile smile smile
smile smile smile smile
Caractères restants: 3000
captcha