Альтернативный инструмент для инструмента типа GhostDoc

Ответ 1

Если вы начинаете комментарий с///в VS2010, он будет создавать базовые параметры в XML для вас на основе функции, которую вы комментируете.

http://msdn.microsoft.com/en-us/magazine/dd722812.aspx

Итак, печатая///перед тем, как функция startMonitor(ManagementScope scope) дает...

/// <summary>
/// 
/// </summary>
/// <param name="scope"></param>
static void startMonitor(ManagementScope scope)

Если вы хотите создать из них приличную документацию, я предлагаю https://github.com/EWSoftware/SHFB в качестве вашей первой остановки. Это довольно туз.

Ответ 2

Собственно, /// не создает никакой документации, просто пустые теги XML. В тех случаях, когда GhostDoc сияет, вы создаете документацию стиля MSDN (включая словоблудие) автоматически на основе контекстной информации, такой как свойство, класс, видимость, обычаи и т.д.

Вот некоторые истинные альтернативы:

• Atomineer (бит дешевле GhostDoc)
• Resharper (работает только в том случае, если вы включили XML-комментарии для проекта, но не так хороши, как выше двух). Также можно скопировать комментарии XML из базовых классов/интерфейсов).

Теперь, что бы вы ни делали, не создавайте undocumentation!:)

Ответ 3

Взгляните на Sandcastle. Он будет работать с проектами Visual Studio 2005. Есть также загрузки, доступные для nDoc. Это имело период расцвета в 2005 году, но я думаю, что с тех пор практически ничего не происходило.

Если вы ищете что-то, что будет на самом деле предкомментировать комментарии к коду для вас, я не уверен, что вы можете сделать намного лучше, чем GhostDoc.