Имена переменных и комментарии. Синтаксис C#
Помимо написания программного кода, эффективно использующего аппаратные ресурсы вычислительной системы, в обязанности программиста входит написание информативного кода. В период эксплуатации программного продукта, в программный код, вносятся правки, связанные как с изменением функционала, так и с выявленными ошибками. Но прежде, чем внести какие-то изменения в программный продукт, необходимо понять структуру программа, какие функции выполняют те или иные переменные или целые блоки кода. Поэтому хорошим тоном считается оставлять подсказки для тех, кто в дальнейшем будет обслуживать программный продукт.
Напишем программу
static void Main(string[] args)
{
Console.WriteLine("Введите значение");
int a = int.Parse(Console.ReadLine());
Console.WriteLine(a*5/9+32);
}
Запустим код. Введем значение, получим результат. И….. Попытаемся угадать, результат каких вычислений был получен.
А теперь представьте себе, вы открываете код и видите применение такого стиля оформления у программы в 1000 строк. Даже если эту программу написали Вы, для понимания происходящего в этом коде придется потратить много времени.
Избежать этого позволило бы наличие комментариев
static void Main(string[] args)
{
/* Эта программа переводит значение температуры
* по Фаренгейту в значение температуры по Цельсию */
Console.WriteLine("Введите значение"); //Температура по Фаренгейту
int a = int.Parse(Console.ReadLine());
Console.WriteLine(a*5/9+32); //Температура по Цельсию
}
Комментарии можно размещать в любом месте программного кода. Комментарии могут быть однострочными и многострочными. Как правило однострочный комментирует только одну строку, многострочный описывает блок программного кода. Многострочный комментарий обертывается в слеш со звездочкой, однострочный пишется после двойного слеша и действует до конца строки.
С помощью многострочного комментария некоторые программисты блокируют готовые блоки кода. Это делается в случаях, когда программист сомневается какой вариант программного кода оптимален для программы.
static void Main(string[] args)
{
/* Эта программа переводит значение температуры
* по Фаренгейту в значение температуры по Цельсию */
Console.WriteLine("Введите значение");
int a = int.Parse(Console.ReadLine());
Console.WriteLine(a * 5 / 9 + 32); //Первый вариант вычислений
/*
* int b = a * 5 / 9 + 32; //Второй вариант вычислений
Console.WriteLine(b);
*/
}
Написание комментариев подчинены определённым правилам.
Первое и главное правило комментария – комментарий должен предоставлять правдоподобную информация.
Комментарии могут предоставлять дополнительную информация или пояснять назначение кода.
Комментарии могут подсказать как улучшить код, если код, в силу каких-то причин, был написан не удачно.
Комментарии могут предупреждать об опасностях внесения изменений в код. Самый распространенный из таких комментариев – “НЕ ТРОГАТЬ!!!”. На эту тему, на просторах интернета, есть поучительная история про вентилятор, воздушный шар и комнату, набитую швабрами.
Еще одним элементом в написании информативного кода являются ИМЕНА.
Имена присваиваются не только переменным, но другим объектам, хранящимся в памяти, таким как массив или другая структура данных, метод, класс и т.д. Подменяя уникальный адрес в памяти компьютера, имя объекта должно быть само уникальным и идентифицировать объект среди других объектов. Не информативно названые объекты затрудняют понимание программного кода другими программистами, а значит увеличиваются затраты на поддержку и обслуживание программного продукта. В конечном итоге, затраты и сложность в обслуживание может лишить программный продукт конкурентных преимуществ, что приведет к отказу от его использования.
Для выбора имени переменной или другого объекта существуют определенные правила.
Нельзя использовать ключевые слова и определенные символы вне строковых значений. У каждого языка программирования свой набор таких слов и символов. К примеру, слово string зарезервировано как обозначение типа данных, а слово — goto приведет к ошибке выполнения программы.
Объектам, т.е. переменным, массивам, методам, классам и т.д. принято задавать удобочитаемые, описательные имена, которые объясняют, для чего создан объект.
Применение простых имен таких как a, b или z обычно используются внутри небольших блоков программы, где однозначно определено для чего нужна переменная
Если имя, для уникальности или смысловой нагрузки должно содержать два и более слова, эти слова пишутся слитно— thisFirstVariable. В языке C# к таким словам применяется стиль написания — Верблюжья нотация. Для этой нотации характерно следующее написание— Первое слово пишется со строчной буквы, последующие — с заглавной. Торчащие посреди заглавные буквы выглядят как горб у верблюда.
Имена переменных, массивов и других структур данных начинаются с маленькой буквы, а методы и классы с большой.
Длина имени не больше 15 символов. Имя объекта — thisFirstVariableofSquareClassRectangle, только усложнит чтение кода.
Для примера.
static void Main(string[] args)
{
int firstVariable = 10;
int secondVariable = 10;
int resultSum = firstVariable + secondVariable;
Console.WriteLine(resultSum);
}
Однако не всегда есть необходимость так полно информировать о принадлежности переменной, скорее это относится к глобальным переменным, о которых мы расскажем чуть позже. Имена переменным внутри небольших кусочков кода, таких как операции ветвления, повторения, лучше присваивать имена вида— a, b, c, y, x.
В заключении.
В задачи программиста входит написание не только эффективного программного кода. Для дальнейшего обслуживания написанный программный код должен быть понятным и удобочитаемым для других программистов. Для создания информативности используют комментарии, для удобочитаемости кода используют имена объектов
Комментарии поясняют предназначение как отдельных команд, так и целых блоков программного кода.
Имена объектов указывают, что хранит объект, его принадлежность и т.д.
На этом занятие закончено.
Вы можете самостоятельно найти задачи для закрепления теоретического материала или для получения задач с ответами отправьте письмо на basicprog@mail.ru
Удачи в выполнении практических заданий!