Ответ 1
Согласно поведению GhostDoc, <c>true</c>
является правильным ответом. Я проголосовал за комментарий Сараванана теперь, когда я смог это подтвердить.
Какой тег комментария к документации на С# xml используется для литералов true
, false
и null
?
В собственной документации Microsoft эти литералы выделены жирным шрифтом. Например, документация для свойства ArrayList.IsFixedSize выглядит так:
true if the ArrayList has a fixed size; otherwise, false. The default is false.
Похоже, что ни один из рекомендуемых тегов Microsoft не подходит для этой ситуации. Лучше всего подходит & lt; c & gt;, однако <c>true</c>
отображается как true
, когда документация выполняется Doxygen.
Однако использование <b>true</b>
с Doxygen дало жирный текст, как я и предполагал. Но это заставляет меня задуматься о переносимости использования стандартных тегов HTML с другими инструментами создания документации, такими как Sandcastle и GhostDoc.
Согласно поведению GhostDoc, <c>true</c>
является правильным ответом. Я проголосовал за комментарий Сараванана теперь, когда я смог это подтвердить.
Вы должны использовать запись <see langword="true">
, чтобы она работала правильно для любого используемого языка.