c # -doc-viewer для VisualStudio - PullRequest
       0

c # -doc-viewer для VisualStudio

0 голосов
/ 09 марта 2012

c # предлагает хороший способ документировать ваш c # -код.Но я не нахожу хорошего зрителя.Я ищу что-то вроде java-doc-viewer в затмении.Этот просмотрщик позволяет вам просматривать в java-документе, просто перемещая указатель мыши, например.имя класса.

Кто-нибудь знает хорошее расширение для Visual Studio 2010, которое содержит такую ​​программу просмотра?

У меня установлено расширение "Инструменты повышения производительности".Но у него нет и реального средства просмотра документов.

Редактировать: Вот картинка, которую я ищу: Example of java-doc-vieser in Eclipse

И это лучшее, что я могу найти для VisualStudio: Doc-Viewer of Productivity Power Tools

Ответы [ 3 ]

1 голос
/ 09 марта 2012

В VS нет встроенного инструмента для просмотра документации вашего кода.Вы должны сгенерировать страницы документации из документа XML, используя внешние инструменты.

Бесплатные инструменты:

  • Sandcastle является наиболеехорошо известно, что у него много функций, но, похоже, он больше не поддерживается и довольно сложен в использовании (хотя Sandcastle Help File Builder делает его значительно проще и поддерживается до сих пор).
  • document проще в использовании, но не относится к .NET
  • Monodoc (из проекта Mono)

Коммерческие инструменты:

  • VSdocman
  • Документ!X
  • Doc-O-Matic
  • ForgeDoc : это довольно новое и выглядит очень многообещающе: очень легко, простоиспользовать, быстро, хорошо выглядящий вывод ... Это также намного дешевле, чем другие выше
1 голос
/ 09 марта 2012

Вы пытаетесь использовать CR_Documentor , если вы не возражаете против установки Code Rush (только для этой цели; на самом деле вам нужен только бесплатный "DXCore", посетите домашнюю страницу проекта для получения дополнительной информации).

Обратите внимание, что этот инструмент не требует предварительного создания документации с использованием таких инструментов, как Sandcastle. Он работает, просто поместив курсор в блок комментария API, например, что метода.

Очевидно, что это имеет некоторые недостатки, например, ссылки на другие элементы (например, <see/> или <seealso> будут отображаться как ссылки, но не будут работать как таковые).

Вот как это выглядит:

enter image description here

Я использовал его однажды, в далеком прошлом , когда он все еще поддерживался оригинальным автором Лутцем Редером , и он хорошо справился со своей задачей. С тех пор я им не пользуюсь.

Обновление : Вы также можете использовать ReSharper, который предоставляет функцию " Quick Documentation ".

0 голосов
/ 09 марта 2012

Вы можете использовать NDoc для создания документации API и создания файлов справки (обычно файлов HTML)

http://sourceforge.net/projects/ndoc/

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...