Главная » Java » Основные конструкции языка Java

0

В  программу, написанную на языке Java, можно добавлять любые текстовые  комментарии,  чтобы  пояснить,  для  чего нужна конкретная строчка  кода,  метод  или  класс.  Через некоторое  время бывает  тяжело  вспомнить, почему вы  написали программу именно так,  а  не  иначе.  Ещё  одна  причина  писать  комментарии -­? это  помочь другим  программистам понять  ваш  код.

Комментарии в программе

Существует  три типа комментариев:1. Если  ваш комментарий укладывается в одну строку, начните егос  двух косых черт:

// Этот метод вычисляет расстояние

2. Более  длинные многострочные комментарии должны бытьокружены символами  /* и */,  например:

/* следующие 3 строки кода

нужны для сохранения позиции рыбы.

*/

3. Вместе с Java  поставляется  утилита javadoc,  которая позволяет  извлечь  комментарии  из  вашей  программы  в отдельный  файл  справки.  Этот  файл  может  быть  использован  в  качестве  технической   документации  для ваших  программ.  Такие

комментарии  должны находиться  между  символами  /**  и  */. Только самые важные комментарии, такие как  описание класса или метода,  следует помещать между  этими  символами.

/**  Этот метод вычисляет размер скидки  в зависимости от цены. Если цена больше $100, скидка = 20%,в противном случае только 10%.

*/

Далее  я  буду  добавлять  комментарии  в  примеры кода,  чтобы дать лучшее представление о том, где и как их использовать.

Источник: Java  Programming for Kids, Parents and Grandparents by Yakov Fain

По теме:

  • Комментарии