Как ссылаться на ошибки в XML Комментарии - PullRequest
Новая
       60

Как ссылаться на ошибки в XML Комментарии

0 голосов
/ 13 марта 2020

Я сейчас исправляю ошибки в C# коде и хочу документировать сделанные исправления. Часто я добавляю раздел remark или devdoc, где описываю причину некоторых неочевидных результатов или кода и обычно оставляю подсказку в тексте о соответствующей ошибке. Вот так: 

/// <devdoc>
///     Hint: Because of .... we use the database view xyz instead of abc. See Bug #123 for more information.
/// </devdoc>

Это нормально, но я хочу улучшить:

  • Могу ли я специально пометить текст "Ошибка # 123" как подсказку для ошибки ?. В https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/see я не нашел такого тега. Есть ли что-то еще?
  • В идеале я хотел бы добавить заголовок ошибки, например, «Ошибка # 123 в некоторых случаях ошибочная дата», как одну семантическую единицу.
  • Кроме того, поскольку мы используем багтрекер Я хотел бы добавить ссылку на ошибку

В настоящее время мне нравится это 

See also <see href="https://collaboration.xyz.com/redmine/issues/123"/>

, но это не так. Есть ли лучший, стандартизированный способ упоминать ошибки в XML комментариях?

...