Liens dans Visual Studio Commentaires?

Question

Lors de l'examen des méthodes efficaces de documenter notre VB projet .NET, par l'expérimentation que j'ai découvert que je peux faire un commentaire comme

'See the file at file://path_to_file 

et je peux ensuite ctrl-cliquer sur ce lien pour afficher le fichier dans une nouvelle languette. Cette fonctionnalité et peut-être d'autres fonctionnalités des commentaires Visual Studio sont-elles documentées quelque part? Je voudrais faire un système de documentation composé d'une page html qui lie au code, et vice versa.

Answer 1

Je ne suis pas sûr de revenir au code de la documentation mais vous pouvez utiliser des commentaires XML et essayer Sandcastle Help File Builder. Je l'ai utilisé une ou deux fois avec des commentaires XML en C#, mais la rumeur dit qu'il peut aussi être utilisé avec VB.Net. Fondamentalement, vous commentez votre code et ensuite configurer un projet Sandcastle pointant vers votre projet VS, et il construit votre documentation pour vous. Vous pouvez choisir une sortie HTML Help 1.x (.CHM) ou HTML Help 2.x (.HxS). En outre, parce qu'il est basé sur XML, vous pouvez personnaliser la sortie en modifiant (ou en créant vos propres) fichiers XSL.