Создаем документацию по проекту
Если вам необходимо написать документацию по вашему проекту и вам необходимо сделать это быстро, то данный пост должен быть вам полезен.
В первую очередь вам необходимо задокументировать код с помощью XML тегов:
///
/// MyClass description.
///
public class MyClass{
///
/// Public constructor.
///
/// myString description.
public MyClass(string myString) { }
}
После этого вам нужно зайти в свойства вашего проекта и убедиться, что XML documentation file у вас выбран:
После компиляции проекта вы увидите кроме бинарных файлов еще и XML файл с вашей документацией.
После этого качаем Sandcastle Help File Builder, который можно скачать на codeplex.
После установки Sandcastle Help File Builder (проверьте, что сам Sandcastle у вас установлен) запускаем, выбираем нужный файл / библиотеку и генерируем документацию:
После этого мы получим в зависимости от настроек chm файл и (или) веб-сайт в стиле MSDN:
Просто и, главное, быстро!