Только в простейшем случае исходная программа может состоять из одного файла, гораздо чаще приходится иметь дело с несколькими файлами – программными модулями (см. примеры консольного и оконного приложений).
Комментариями называются те части программных модулей, которые при компиляции игнорируются.
Зачем же тогда даже опытные программисты вставляют их в тексты своих программ?
Первая причина – сохранение выходных данных программы (наименование, назначение, версия, связь с другими модулями, авторские права, время создания или последнего изменения).
Вторая причина – обеспечение понимания структуры и логики программы, так как даже ее автор спустя некоторое время, когда потребуется анализ или корректировка программы, забывает их.
Третья причина – обеспечение понимания программы другими программистами – коллегами, руководителями и учениками.
Можно сказать, что разумные комментарии являются простейшим способом документирования процесса разработки программного обеспечения.
Комментарии являются немаловажной частью любого языка программирования, т.к. позволяют удобно пояснять различные участки кода.
В C# используются традиционные комментарии в стиле С — однострочные (//…) и многострочные (/* . . . */):
// Это однострочный комментарий
/* Это уже
многострочный комментарий */
Все, что находится в однострочном комментарии — от // до конца строки — игнорируется компилятором, как и весь многострочный комментарий, расположенный между /* и */.
Очевидно, что в многострочном комментарии не может присутствовать комбинация */, поскольку она будет трактоваться как конец комментария.
Многострочный комментарий можно помещать в одну строку кода:
Console.WriteLine (/* Здесь идет комментарий! */ «Это скомпилируется»);
Встроенные комментарии вроде этого нужно применять осторожно, потому что они могут ухудшить читабельность кода. Однако они удобны при отладке, скажем, когда необходимо временно попробовать запустить программу с указанным другим значением:
DoSomethingMethod (Width, /*Height*/ 100);
Символы комментария, включенные в строковый литерал (между кавычками), трактуются как обычные символы:
string s = «/* Это просто нормальная строка */»;
Пример комментирования (несколько избыточного) вашей первой программы:
/* Консольное приложение: Первая программа
Программа – приветствие. Версия 1.2
(C) Иван Петров, Камышин, 01.01.2018 */
using System; // Подключение библиотеки System
// Объявление пространства имен «Первая программа»
namespace Первая_программа
{
class Program // Объявление класса Program
{
// В этом классе объявляется функция Main() -точка входа в приложение
static void Main(string[] args)
{
Console.WriteLine("Привет, программист!"); //Вывод приветствия
Console.ReadKey(); // Реакция на нажатие клавиши
}
}
}
Далее обращайте внимание на комментарии к примерам, решайте сами, помогают ли они, по сути, понять программы.
Перейдем к важнейшей теме Типы данных в языке C#
NEW: Наш Чат, в котором вы можете обсудить любые вопросы, идеи, поделиться опытом или связаться с администраторами.
|
|
|
|