Hello everybody
Below comment is just a piece of xml comment in VS but my problem is characters like < > that break the xml structure. How can I use them in an xml comment?
/// <param name="index">square index on board which 1<=index<=64</param>
views:
56answers:
3
+3
A:
I would reword it to be more a sentence and less an equation:
/// <param name="index">square index on board, between 1 and 64</param>
Kate Gregory
2010-07-16 20:00:11
Between means 1 and 64 included ?
Freshblood
2010-07-16 20:17:05
If you are concerned that your audience for the comment might think a chessboard could be 2 <= index <= 63, you could say "between 1 and 64 inclusive." I think the importance of the comment is really to distinguish "0-63" from "1-64". But word it as you feel you need to for those who will read it.
Kate Gregory
2010-07-16 20:48:30
I think that will look awful when you're reading the code. I also think more people will read the code than will read the doc you generate from it.
Kate Gregory
2010-07-16 20:49:20
+1
A:
/// <param name="index">square index on board which 1<=index<=64</param>
OR
/// <param name="index">square index on board which 1〈=index〈=64</param>
The latter option is unicode: 〈 〉
Joshua
2010-07-16 20:05:36