Как использовать ‹ › в комментариях Visual Studio?

Комментарий ниже - это всего лишь часть комментария xml в VS, но моя проблема заключается в таких символах, как < >, которые нарушают структуру xml. Как я могу использовать их в комментарии xml?

/// <param name="index">square index on board which 1<=index<=64</param>

visual-studio xml-comments
person Freshblood    schedule 16.07.2010    source источник
comment
А как насчет &lt и &gt, они будут работать?   -  person sbi    schedule 17.07.2010
comment
Дай угадаю, шахматы/шашечная доска? :п   -  person Psytronic    schedule 17.07.2010
comment
@Psytronic Это шахматный движок, который я еще не опубликовал на codeplex :)   -  person Freshblood    schedule 17.07.2010

Ответы (3)


arrow_upward
4
arrow_downward 

/// <param name="index">square index on board which 1&lt;=index&lt;=64</param>

OR

/// <param name="index">square index on board which 1〈=index〈=64</param>

Последний вариант — юникод: 〈 〉

person Joshua    schedule 16.07.2010
comment
Зачем использовать юникод, если меньше и больше, чем часть спецификации xml? Не критика, просто удивление. - person Psytronic; 17.07.2010
comment
В зависимости от шрифтов он может быть сразу читаем как в комментарии, так и в извлечении xml. - person Joshua; 17.07.2010

arrow_upward
5
arrow_downward

Я бы переформулировал это так, чтобы оно было скорее предложением, чем уравнением:

/// <param name="index">square index on board, between 1 and 64</param>
person Kate Gregory    schedule 16.07.2010
comment
Между средствами 1 и 64 включены ? - person Freshblood; 17.07.2010
comment
Если вы обеспокоены тем, что ваша аудитория комментария может подумать, что шахматная доска может быть 2 ‹= индекс ‹= 63, вы можете сказать от 1 до 64 включительно. Я думаю, что важность комментария действительно состоит в том, чтобы отличить 0-63 от 1-64. Но скажите это так, как считаете нужным для тех, кто будет это читать. - person Kate Gregory; 17.07.2010

arrow_upward
4
arrow_downward

Попробуйте их кодировать? используя и

person Psytronic    schedule 16.07.2010
comment
Я думаю, что это будет выглядеть ужасно, когда вы читаете код. Я также думаю, что больше людей прочитают код, чем документ, который вы сгенерируете из него. - person Kate Gregory; 17.07.2010