Теперь, получив рабочую программу, имеет смысл задокументировать все, что она делает, причем непосредственно внутри ее исходного кода. Если вы когда-либо программировали на другом языке, то, вероятно, уже знаете значение внутренней документации. Если вы вернетесь к приложению в будущем (через много месяцев или даже лет), то будете озадачены своей предыдущей работой. Возможно, поддерживать ваш код будет совершенно другой человек, так что оставляйте в коде комментарии, которые помогут объяснить происходящее - это определенно хорошая практика.

Чтобы добавлять однострочный комментарий, используйте следующий синтаксис:

// Однострочный комментарий

Все, что находится после символов //, компилятор игнорирует и не включает в окончательное приложение. Давайте задокументируем наше приложение Windows.

//После щелчка на кнопке отобразить текст в текстовом поле
private void button1_Click(object sender, EventArgs e)
{
    textBox1.Text = "Привет МИР!";
}

Всегда стоит оставлять простые комментарии наподобие данного, поскольку это существенно поможет при разработке логики приложения. Но что, если вы хотите оставлять более длинные комментарии, в несколько строк, например, подробно описать целый класс? В таком случае вы использовали бы синтаксис многострочного комментария.

/* Первая строка многострочного комментария
 * Вторая строка
 * Третья строка
 */

Как можно заметить, начинает многострочный комментарий символ /*, а завершает символ */; все, что между ними, компилятор игнорирует. Обратите внимание, звездочки перед второй и третьими строками добавлены средой Visual С# Express исключительно для украшения, многострочному комментарию они не нужны. (Другими словами, вы не обязаны использовать такие звездочки, хотя вполне можете, если хотите. Но завершающий символ */ обязателен.)

Давайте напишем многострочный комментарий для нашего приложения Windows.

namespace Example1
{
    /* Пример простой формы для Главы 1, отображающей текст, когда
     * пользователь щелкает на кнопке. Это первая программа,
     * управляемая событиями.
     */

    public partial class Form1 : Form
    {
        public Form1()
        {
            InitializeComponent();
        }
 

        //После щелчка на кнопке отобразить текст в текстовом поле
        private void button1_Click(object sender, EventArgs e)
        {
            textBox1.Text = "Привет МИР!";
        }
    }
}

Среда Visual C# Express поддерживает и другие типы комментариев, которые могут иметь преимущества как для конечных пользователей, так и для других программистов, просматривающих ваш код. Вы узнаете о них в главе 10, "Все о персистентности".