Главная » Java » Комментарии

0

 

Изучая программный код примеров, вы наверняка не могли не заметить текст на обычном "человеческом" языке – он оформлен в виде комментариев (comments). Существуют три стиля комментирования, и все они проиллюстрированы в программе Fibonacci. позволяют снабдить код внятными описаниями, содержащими дополнительные разъяснения, которые способны помочь будущим пользователям программы. В роли подобного пользователя можете оказаться и вы сами – скажем, через пару месяцев или лет. Не ленясь и подробно комментируя собственный программный код сегодня, вы существенно облегчите свою участь завтра. Кроме того, процесс написания комментариев зачастую помогает отыскать ошибки – это вполне естественно, поскольку, пытаясь описать словами назначение конструкций программы, вы невольно вынуждены еще раз над ними поразмыслить.

Любой текст, расположенный между парами символов /* и */, компилятором в расчет не принимается. Подобный стиль применим для написания комментариев, расположенных в пределах части строки, охватывающих целую строку или, в общем случае, несколько строк (как в нашем примере). Для того чтобы снабдить комментарием целую строку или ее часть, удобно применить пару символов / /, которая предписывает компилятору игнорировать все, что находится далее в пределах той же строки.

Третий способ комментирования, предусматривающий использование конструкций /** и */, продемонстрирован в самом начале программы. с двумя символами звездочки (*) в начале применяют для документирования программ и называют кратким термином doc commeпts. документирования предназначены для описания следующих за ними объявлений. В рассматриваемом при мере подобный комментарий предшествует объявлению метода main. Если комментарии оформлены в строгом соответствии с указанным правилом, код может быть успешно обработан специальными программными средствами, позволяющими автоматически извлечь информацию комментариев и сгенерировать на ее основе удобную справочную документацию. В соответствии с принятым соглашением строки, заключенные в пределах комментария документирования или обычного комментария в стиле /* … * /, снабжаются начальным символом звездочки (*), который игнорируется инструментами автоматического документирования и позволяет наглядно указать читателю границы комментария.

 

Источник: Арнолд, Кен, Гослинг, Джеймс, Холмс, Дэвид. Язык программирования Java. 3-е изд .. : Пер. с англ. – М. : Издательский дом «Вильяме», 2001. – 624 с. : ил. – Парал. тит. англ.

По теме:

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