C# комментирует [закрытое] учебное руководство
utf[0] правильно. Эта запись относится ко всем конечным байтам; utf[j] описывает начальный байт в последовательности длины j.
4 ответа
Это довольно интересно сделать с комментариями xml: http://thoughtpad.net/alan-dean/cs-xml-documentation.html
Они читаются замком из песка также...: o)
Это Сообщение Jeff Atwood на его блоге, Кодирующем Ужас, входит в цель комментариев в целом. Что-то Вы могли бы думать, 'понятное дело' действительно не - особенно в 'реальном мире', когда Вы видите комментарии как тот ниже:
//Connect to the Database
Db.Connect();
И конечно, существует заключение к тому сообщению: Кодирование Без Комментариев.
Что-то, что я считал только что (и потеряли след того, где):
- Новички ничего не комментируют
- Ученики комментируют очевидное
- Подмастерья комментируют причину того, чтобы сделать его
- Комментарий Masters причина того, что не был сделан он иначе
В VS
Комментарии относительно просты.
Можно использовать для одной строки:
//This is a single line comment
Можно использовать для нескольких, выровняйте:
/*
Multiple lines
*/
Для метода можно использовать:
/// <summary>
/// This is a description
/// </summary>
/// <param name="sender">Description of variable SENDER</param>
/// <param name="e">Description of variable E</param>
Вне VS
При входе в Свойство проекта, можно произвести все комментарии в XML и управлять ими.
Хорошая практика
Комментарии не должны использоваться для описания то, ЧТО код делают, но ПОЧЕМУ или КАК, если это не ясно.