Гость
Войти | Профиль | Очистить
Целевая тема:
Создать новую тему:
Автор:
Действия ...
Форумы / WinForms, .Net Framework [игнор отключен] [закрыт для гостей] / Документирование кода на C# в xml и html / 3 сообщений из 3, страница 1 из 1
25.02.2005, 14:32
    #32933631
snooker
snooker
Участник
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Документирование кода на C# в xml и html
Код: plaintext
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.
27.
Вот такой код, скопирован прямо из из хелпа VS 2003 C#, попробовал сгенерировать

1. сгенерированный xml файл выдает ошибку - нет 3-го столбца, и в браузере рисует только xml теги

2. При генерации html документации "Tools->Build Comment WEB Pages" ссылки seealso вообще не работают, а также не работают теги <para>, <newpara>. Помогите разобраться! 


 // xml_summary_tag.cs
// compile with: /doc:xml_summary_tag.xml


/// text for class MyClass
public class MyClass
{
	/// <summary>MyMethod is a method in the MyClass class.
	/// <para>Here's how you could make a second paragraph in a description. <see cref="System.Console.WriteLine"/> for information about output statements.</para>
	/// <seealso cref="MyClass.Main"/>
	/// </summary>
	public static void MyMethod(int Int1)
	{
	}

	/// text for Main
	public static void Main ()
	{
	}
}
...
Рейтинг: 0 / 0
| Ответить | Цитировать | Написать  
01.03.2005, 11:30
    #32938160
snooker
snooker
Участник
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Документирование кода на C# в xml и html
Я имею в виду, что теги <cref ..... > в сгенерированном html у меня просто не работают!
Сколько встречал статей на тему документирования кода, везде такое впечатление, что нет проблем ни у кого, кроме меня.

Кто с этим работал, подскажите, действительно документация генерируется неправильно, или что-то неправильно делаю?

Сергей Новожилов
...
Рейтинг: 0 / 0
| Ответить | Цитировать | Написать  
01.03.2005, 15:59
    #32939136
snooker
snooker
Участник
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Документирование кода на C# в xml и html
Вот, вроде разобрался, тег seealso в Web reports не поддерживается.........

Code comment Web reports recognize the following XML tags:

<summary></summary> Describes a member for a type.
<remarks></remarks> Specifies overview information for a class or other type.
<param></param> Used in the comment for a method declaration to describe one of the parameters for the method.
<returns></returns> Used in the comment for a method declaration to describe the return value.
<newpara></newpara> Starts a new paragraph in the comments.


Вопрос к знатокам .NET IDE - можно ли как-то без серьезного программирования заставить работать метку xml ?

<seealso cref="member"/>


Такие метки расставляются xml-корректно, за этим следит компилятор, а при генерации html-кода они остаются без изменений. Т.е. вместо такой метки должно быть что-то вроде этого:
<code>
<TD CLASS="TableLightDesc"><A HREF="CWP86.HTM" TARGET="CNTFRAME">метка</A></TD>

Сергей Новожилов
...
Рейтинг: 0 / 0
| Ответить | Цитировать | Написать  
Форумы / WinForms, .Net Framework [игнор отключен] [закрыт для гостей] / Документирование кода на C# в xml и html / 3 сообщений из 3, страница 1 из 1
Найденые пользователи ...
Разблокировать пользователей ...
Читали тему (0):
Читали форум (0):
Пользователи онлайн (0):
x
x
Закрыть


Просмотр
0 / 0
Close
Debug Console [Select Text]