В основном возникает вопрос: где (и в каком формате) я должен хранить текстовую документацию разработчика, связанную с моими проектами Visual Studio?
Разработать: комментарии XML замечательные, но они не охватывают все варианты использования. Иногда вы хотели бы описать архитектуру класса проекта на высоком уровне, добавить примечания к использованию в свою библиотеку или просто оставить любое другое сообщение для будущих поколений разработчиков, работающих над этим проектом.
Я хотел бы добавить эти документы непосредственно в виде файлов в проект Visual Studio, чтобы (а) они были доступны разработчику без дальнейшего поиска и (б) они управляются версией (используя тот же svn/ git/любой репозиторий в качестве исходного кода).
В настоящее время я добавляю в проект папку _Documentation
и использую текстовые файлы, но я не уверен, что это лучшее решение. Visual Studio не имеет возможности для автоматического текстового текста 1 а вручную фиксирует разрывы строк после каждого изменения, раздражает. С другой стороны, документы Word не очень хорошо работают с управлением версиями, и TeX слишком много хлопот для настройки и обучения на каждом компьютере разработчиков.
Есть ли у вас хорошо зарекомендовавшая себя практика?
1 Я знаю, что там Edit/Advanced/Word-Wrap, но это влияет только на экран, а не на сам файл.