В исходном коде на языке C# доступна возможность оставлять комментарии, которые будут проигнорированы компилятором и не окажут никакого эффекта на итоговую программу.
Есть 2 способа это сделать:
🔸 Однострочный комментарий - начинается с двойных слешей
// Adds two integers and returns the result
public static int Add(int a, int b) {
}
🔸 Многострочный комментарий - окружён с обоих сторон слешом и звёздочкой
/*
The main Math class
Contains all methods for performing basic math functions
*/
public class Math {
}
Отдельно стоит упомянуть так же XML Comments (подробнее), которые благодаря стандартизации в дальнейшем используются не только при подсказках IntelliSense, но и являются источником данных при генерации документации на основании кода (например в Swagger):
/// <summary>
/// This class performs an important function.
/// </summary>
public class MyClass {}
☝️ Полезными в данном случае горячими клавишами при разработке являются Ctrl+K, Ctrl+C (закомментировать выделенное) и Ctrl+K, Ctrl+U (раскомментировать выделенное).
Подробнее по теме порекомендую почитать следующую статью: комментирование кода - хорошие, плохие и отвратительные комментарии.
#basics