Как добавить документацию на уровне папок в сборки C #? - PullRequest
Новая
       29

Как добавить документацию на уровне папок в сборки C #?

2 голосов
/ 25 мая 2010

Я: Я относительный новичок в платформе .NET.

Проблема

В Java вы можете добавить документацию уровня пакета в свой проект.создав файл package-info.java или package.html и сохранив его в папке пакета.Как добавить эквивалентную документацию к моему проекту в C # с использованием Visual Studio 2010?

Фон

Мне нравится писать документацию, описывающую мои мотивы в контексте уровня пакета / папкипроектов исходного кода, над которыми я работаю.Я очень привык к этому рабочему процессу на разных языках (особенно на Java), и я считаю, что это хороший способ документировать свой проект.

Ответы [ 2 ]

3 голосов
/ 25 мая 2010

C # автоматически превратит основанные на XML комментарии тройной косой черты в документацию intellisense. 

///<summary>This method does something!</summary>
///<parameter name="p1">The first parameter</parameter>
///<return>true, if the method completed successfully</return>
public bool DoSomething(int p1){
  return p1 > 0;
}

Когда вы компилируете свой проект в библиотеку классов и ссылаетесь на него в другом проекте, вышеприведенное автоматически превращается в полезную подсказку. Кроме того, компилятор C # может дополнительно создавать XML-файл со всеми этими комментариями вместе с вашей DLL. Этот XML-файл может быть передан в Sandcastle (как уже упоминалось ранее) и добавлен в проект документации в виде справочника по API в стиле MSDN.

Инструмент Sandcastle имеет свою собственную структуру проекта и документации, поэтому вы захотите запустить сторонний проект, если собираетесь добавить что-то большее, чем сгенерированная в XML ссылка на Intellisense.

1 голос
/ 25 мая 2010

Фокус немного отличается в .NET, он очень хорошо поддерживает генерацию информации IntelliSense. Документация у вас под рукой. Я уверен, что вы знакомы с ним, когда вы некоторое время использовали VS, посмотрите «документацию xml».

Офф-лайн документы раньше покрывались NDoc, но парень, который поддерживал его, ушел из своего проекта. Проект Sandcastle занял свое место. Кажется, в наши дни тоже немного отстает.

...