пользовательская документация для кода C#

Есть ли настраиваемый генератор документации для C#? В отличие от собственной XML-документации, которая предоставляет документацию для классов, методов, свойств, документация, на которую я имею в виду, более низкоуровневая, то есть она документирует поток метода.пользовательская документация для кода C#

, например, в данном коде

void SomeMethod(){ 

///doc:Do X 
SomeCodeToDoX 

///doc:Do Y 
SomeCodeToDoY 

///not tagged 
SomeCode 

}

Документация будет захватить документ: Do X и док: Do Y, и документ Do X и Do Y, как поток внутри метода SomeMethod

** Я надеюсь, что я сделал этот вопрос достаточно ясно .. если я не пожалуйста прокомментируйте спросить разъяснения *

источник

2010-07-27 Louis Rhys

Интересная идея, хотя я бы сказал, что, если ваши методы являются настолько большими и сложными что они требуют документации * внутри * метода, тогда вам, вероятно, придется рефакторировать, а не пытаться это сделать ... –

Я бы не хотел выставлять этот комментарий. Это может помешать программистам прокомментировать код «внутри коробки» –

@graphain: Моя идея - иметь тег, который указывает, что этот комментарий является частью документации, без тега комментарии не будут задокументированы. –

не знаю, если это отвечает на ваш вопрос, но вы можете использовать SandCastle: http://sandcastle.codeplex.com/

Он создает документацию MSDN, отражая сборки. Вы можете (но не обязательно) добавлять свои собственные теги документации.

источник

2010-07-27 04:39:21 Icemanind

Вы можете использовать любые XML-элементы, которые вам нравятся в комментариях к доктору, насколько мне известно, но они должны быть привязаны к члену; Я боюсь, вы не можете просто добавлять комментарии к кодам кода внутри метода.

Или, по крайней мере, вы можете, но он не будет определена как часть созданного файла XML, и вы получите предупреждение, как это:

Test.cs (11.9) : предупреждение CS1587: XML комментарий не помещается на действительный элемент языка

Это возможно, что если отключить это предупреждение и использовать Doxygen для обработки исходного кода вместо встроенного генератора, вы может быть может получить что-то ... но вы должны знать, что у него будет очень, характерный для вашей среды. Я подозреваю, что выгоды не будут стоить самой боли. Я также предупреждаю о читаемости кода, в котором есть большое количество комментариев, - он может очень отвлекать вас, когда вы действительно хотите увидеть сам код.

(почему-то так ненадежен, когда я пытаюсь разместить ссылку на Doxygen ... подам ошибку на Meta.)

источник

2010-07-27 05:24:28

пользовательская документация для кода C#

ответ

Смежные вопросы