2012-03-09 4 views
0

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

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

У меня есть «Производительность электроинструментов» - Расширенная установка. Но он не был настоящим док-зрителем.

Edit: Вот картина того, что я ищу: Example of java-doc-vieser in Eclipse

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

ответ

1

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

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

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

Это то, что он выглядит следующим образом:

enter image description here

Я использовал его один раз, путь назад when it was still maintained by the original author Lutz Roeder, и это сделало его работу хорошо. Я не использовал его с тех пор.

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

+0

Быстрая документация ReSharper выглядит неплохо. Благодаря! – Lukas

0

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

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

+0

NDoc более или менее мертв или «устарел» (последнее обновление, которое обновляется на их [домашней странице] (http://ndoc.sourceforge.net/) с 2005 года) - к сожалению, как говорят некоторые. Кроме того, я сомневаюсь, что когда-либо был «мгновенный зритель» для VS. –

1

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

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

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

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

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

Возможно, вы захотите добавить подсказку о том, что некоторые инструменты (например, VSdocman, как они выглядят), на самом деле не требуют предварительного создания документации для ее отображения в Visual Studio (что, по-видимому, ищет OP). –

Смежные вопросы