Строгих правил написания комментариев в коде на C# нет, но есть негласные стандарты. 1 В зависимости от типа комментария используются различные символьные записи: 1
- Однострочный комментарий. 1 Начинается с двух слешей (//). 13 Всё, что находится после косых черт в этой строке, считается комментарием. 3
- Многострочный комментарий. 1 Начинается с /* и заканчивается */. 13 Всё, что находится между этими маркерами, рассматривается как комментарий. 3
- XML-комментарий. 1 В нём используются описания фрагментов исходного кода при помощи XML-тегов. 1 Для таких комментариев в C# используются три слеша (///). 1
Также есть рекомендации по оформлению комментариев: 1
- Место написания. 1 Комментарии пишутся справа от строки, к которой они относятся, или сверху над кодом. 1
- Область комментирования. 1 Рекомендуется оставлять «заметки» только для значимых элементов: функций, модулей, констант, глобальных переменных, классов, интерфейсов и так далее. 1
- Размер комментария. 1 Многострочная «подсказка» должна быть лаконичной и максимально простой, короткой. 1