Подскажите с xml-комментарием
Имеется такой код( упрощенно, конечно ):
/// <summary>
/// Сообщение message было добавлено в очередь.
/// </summary>
/// <param name="message">Сообщение(я).</param>
/// <returns>True - message добавлены, false - в противном случае.</returns>
private bool MessageAdded(byte [] message)
{
return true ;
}
Как в summary сослаться на параметр message ? Как весь xml комментарий правильно переписать ?
Re: Подскажите с xml-комментарием
Здравствуйте, Саша Равный, Вы писали:
СР>Имеется такой код( упрощенно, конечно ):
СР>Как в summary сослаться на параметр message ? Как весь xml комментарий правильно переписать ?
<paramref />
В МСДН есть полное описание всех тэгов вместе с их списком.
С уважением, Анатолий Попов.
ICQ: 995-908
Re[2]: Подскажите с xml-комментарием
Здравствуйте, Aen Sidhe, Вы писали:
AS><paramref />
Примерно так ?
/// <summary>
/// Сообщение <paramref name="message"/> было добавлено в очередь.
/// </summary>
/// <param name="message">Сообщение(я).</param>
/// <returns>True - <paramref name="message"/> добавлены, false - в противном случае.</returns>
private bool MessageAdded(byte [] message)
{
return true ;
}
AS>В МСДН есть полное описание всех тэгов вместе с их списком.
Ну, насчет МСДН я знаю что есть, я вот первоначально предполагал что в моем случае нужны теги see или seealso
Re[3]: Подскажите с xml-комментарием
Здравствуйте, Саша Равный, Вы писали:
СР>Здравствуйте, Aen Sidhe, Вы писали:
AS>><paramref />
СР>Примерно так ?
На, насколько я помню — да.
С уважением, Анатолий Попов.
ICQ: 995-908
Re[4]: Подскажите с xml-комментарием
Здравствуйте, Aen Sidhe, Вы писали:
AS>На, насколько я помню — да.
Я пользовался West Wind HTML Help Builder.
Вот что получил:
Хм, не совсем то, что ожидал.
Re[5]: Подскажите с xml-комментарием
Здравствуйте, Саша Равный, Вы писали:
СР>Здравствуйте, Aen Sidhe, Вы писали:
AS>>На, насколько я помню — да.
СР>Я пользовался West Wind HTML Help Builder.
СР>Хм, не совсем то, что ожидал.
СР>
http://msdn.microsoft.com/en-us/library/b2s063f7.aspx
Читать здесь. Уж извольте на это потратить ваше время.
С уважением, Анатолий Попов.
ICQ: 995-908
Re[5]: Подскажите с xml-комментарием
Здравствуйте, Саша Равный, Вы писали:
СР>Хм, не совсем то, что ожидал.
СР>
А я юзаю
Sandcastle и получаю то, что ожидал...
Там ещё такие штуки прикольные поддерживаются как:
/// <overloads>
/// <threadsafety>
/// <notes>
Пока на собственное сообщение не было ответов, его можно удалить.
Удалить