Документация проектов C# на нескольких языках в VisualStudio

285
29 июня 2017, 00:58

Всем привет! Совсем недавно у меня возникла задача задокументировать весь код в проекте, чтобы при использовании метода, интеллисенс студии подсказывал о нём всё, что только можно. Единственное, что я смог найти для своей ситуации - это XML документация, для .csproj. Но, насколько я понял это получается не слишком красиво и очень громоздко в исходниках. Тем более, если делать через xml:lang="LANG_ID". Какой подход наиболее хороший и правильный, для документирования кода? В конечном итоге, конечно, хотелось бы достичь такого результата, как у дотнета из коробки.

UPDATE #1

Сейчас мне пришла в голову очень странная идея, для моей задачи, мне нужна просто документация для какой-то DLL на разных языках и всё. Думаю написать какую-нибудь тулзню, которая будет подниматься на prebuild эвенте и выставлять везде где нужно документацию, чтобы студия сбилдила XML файл. А на postbuild эвенте будет подниматься тулзня, которая будет очищать все выставленные строчки. Этот подход позволить сделать код чистым от доки и полностью автоматизировать процесс (только саму доку придется править).

Answer 1

Не хочу расстроить, но XML-комментарии, это то единственное, что позволит вам достичь желаемого результата. А для того чтобы процесс их написания не был таким "болезненным" и скучным, от себя могу порекомендовать расширение для Visual Studio под названием GhostDoc, которое позволяет автоматизировать и стандартизировать некоторые рутинные действия и операции.

READ ALSO
Вызов асинхронной функции по таймеру в C#

Вызов асинхронной функции по таймеру в C#

Можно ли как-нибудь вызвать по таймеру асинхронную функцию в C#? У обычного SystemThreading

372
Разработка приложения для Android с C# [требует правки]

Разработка приложения для Android с C# [требует правки]

Читал, что есть Monodroid и Monotouch - фреймворки от XamarinИнформации маловато, оф

160
Оптимизация UI элементов

Оптимизация UI элементов

У меня есть View Model в которой содержится состояние объекта :

198
Как передать в NpgSqlCommand параметр из C#?

Как передать в NpgSqlCommand параметр из C#?

Как можно передать в скрипт параметр _data из c#:

270