Ссылки в Visual Studio Комментарии?

Question

Исследуя эффективные методы документирования нашего проекта VB .NET, экспериментально я обнаружил, что могу сделать комментарий, например

'See the file at file://path_to_file

, и затем я могу нажать Ctrl-клик по этой ссылке, чтобы открыть файлв новой вкладке.Задокументирована ли эта функция и, возможно, другие возможности комментариев Visual Studio где-либо?Я хотел бы сделать систему документации, состоящей из HTML-страниц, которые ссылаются на код, и наоборот.

Answer 1

Я не уверен насчет ссылки на код из документации, но вы можете использовать комментарии XML и попробовать Sandcastle Help File Builder .Я использовал его один или два раза с комментариями XML в C #, но ходят слухи, что его можно использовать и с VB.Net.В основном вы комментируете свой код, а затем настраиваете проект Sandcastle, указывающий на ваш проект VS, и он строит вашу документацию для вас.Вы можете выбрать вывод HTML Help 1.x (.CHM) или HTML Help 2.x (.HxS).Кроме того, поскольку он основан на XML, вы можете настроить вывод, изменив (или создав свои собственные) XSL-файлы.