Як залишати коментарі в коді

15 Вересня, 201615 Вересня, 2016 Vertex Academy

Comments Vertex Academy

Дуже часто при написанні програми необхідно залишити якийсь коментар. Наприклад:

"цей блок коду відповідає за ..."
"ця змінна відповідає за ..."
і т.д.

Повірте, це дуже хороша практика прописувати коментарі. Завдяки цьому:

Ви завжди легко згадаєте, що і до чого в програмі. Стандартна практика –місяць не підходив до коду, відкриваєш його і сам не віриш, що це ти написав ... І ось у цей момент так тепло і радісно на душі, коли бачиш коменти ...
І той, хто після Вас буде працювати з Вашим кодом, скаже Вам величезне спасибі. Вас таки не буде під боком, щоб запитати: "А що це ти, друже, мав на увазі ...?"

Тому пишіть коменти – подбайте про себе і про наступні покоління ...

Отже, як коментувати? Покажемо на прикладі.

Приклад №1

/*
 Программа, демонстрирующая выведение значения 
 переменной на консоль
  */
 
class Test {
    public static void main(String args[]){
        int k = 10;
        System.out.println (k); //выводит на консоль значение переменной k
    }
}

Программа, демонстрирующая выведение значения

переменной на консоль

class Test {

public static void main(String args[]){

int k = 10;

System.out.println (k); //выводит на консоль значение переменной k

}

У прикладі показано, що, якщо коментар написаний в 1 рядок, використовуємо дві косі риси // і далі пишемо наш код:

System.out.println (k); //выводит на консоль значение переменной k

1	System.out.println (k); //выводит на консоль значение переменной k

Якщо ж коментар у нас не в 1 рядок, а в 2 і більше рядків, то використовуємо таку конструкцію для написання коментарів:

/*
 Программа, демонстрирующая выведение значения 
 переменной на консоль
  */

Программа, демонстрирующая выведение значения

переменной на консоль

Тепер Ви вмієте залишати коментарі в коді. Місія статті виконана. Наостанок згадався латинський вислів, який також підходить і до коментарів ....

бережи порядок і порядок збереже тебе