Documentation de code pour l'application ASP.NET + VB.NET

Nous avons une très ancienne application datant de l'ère ASP que nous refactorisons progressivement vers la base de code ASP.NET + VB.NET.Documentation de code pour l'application ASP.NET + VB.NET

Il contient un grand nombre de fichiers avec les types ci-dessous:

ASPX, asmx, ascx, vb, js (JavaScript), html, VBS (VBScript).

La base de données principale est SQL Server 2005 avec beaucoup de sprocs.

Nous aimerions créer une documentation de code générée automatiquement à partir des commentaires dans les fichiers de code. J'ai beaucoup aimé Doxygen, mais il semble qu'il ne supporte pas les technologies ci-dessus. Pouvez-vous suggérer quelques outils générateurs de documents, de préférence un seul outil ou un groupe d'outils?

Merci beaucoup.

Ajit.

Source

2009-07-21 Ajit Singh

Merci d'avoir pris le temps de répondre. J'utilise moi-même beaucoup Sandcastle. SandCastle ne fonctionnerait pas pour moi car il s'agit principalement d'un outil de documentation API, c'est-à-dire qu'il prend des assemblys (dlls) et génère les documents sur différents membres de type. Je suis plus à la recherche d'extraire des commentaires, des graphiques de dépendance de fichiers à partir de fichiers de code source appartenant aux technologies listées ci-dessus. Je voudrais un outil comparatif comme Doxygen pour les technologies ci-dessus. Merci encore. –

Vous pouvez jeter un oeil à l'outil Microsoft's Sandcastle. Je l'ai utilisé plusieurs fois, et il génère de la documentation basée sur les commentaires fournis dans votre code .NET. Si je me souviens bien, il peut aussi générer de la documentation pour les bibliothèques JavaScript.

Source

2009-07-21 04:35:15 Kirtan

Il y en a là-bas:

SandCastle

NDOC

Source

2009-07-21 04:35:33

@Ajit & @Jimmy: NDOC est un outil très très ancien (environ 4 ans). Ce n'est plus sous maintenance. C'est mieux si vous ne l'utilisez pas. – Kirtan

Ah merci :). Je cherchais juste une option secondaire. Dans ma société précédente, nous avons aussi essayé SandCastle pour faire le doc. –

je l'ai utilisé SandCastle et il fonctionne aussi bien si vous avez des commentaires xml dans votre code.

Vous activez d'abord la documentation XML dans votre projet en la définissant dans Propriétés du projet -> Compiler -> Générer la documentation XML. Une fois cela fait, vous devrez peut-être définir les avertissements de traitement comme des erreurs, afin que le studio puisse vous indiquer où et tous les commentaires XML sont manquants.

Pour ajouter un commentaire XML, vous placez votre curseur avant une définition de classe ou une définition de fonction et tapez

///

Cela va générer automatiquement des balises xml pour la documentation et une fois que vous avez terminé, vous pouvez importer le projet et commencer à créer la documentation. La bonne partie est, si vous avez bien documenté vos classes, lorsque vous utilisez ces fonctions dans votre application sur la souris, vous pouvez trouver la description que vous avez écrite, un peu comme la documentation intellisense fonctionne. Informez-moi si vous rencontrez d'autres problèmes.

Ma dernière suggestion, faites un projet hello world et documentez-le en XML et familiarisez-vous avec Sandcastle avec.

Source

2009-07-21 04:55:44

Documentation de code pour l'application ASP.NET + VB.NET

Répondre

Questions connexes