Почему комментарии Java в Eclipse разные цвета? - PullRequest
4 голосов
/ 24 марта 2011

Я новичок в Eclipse и использую его для разработки под Android.Eclipse заставляет меня все больше осознавать плохие привычки, которые я сформировал (IE не использует заглавные буквы в именах классов и т.текст становится зеленым, но когда я использую символы /** **/, текст становится голубым.Для этого есть причина?Какой-то тип спецификации комментариев, который я где-то пропустил?Должны ли они служить различными функциями для разных типов комментариев?

Я использую Helios Service Release 1 (сборка 20100917-0705) для Win 7 (x64), если это что-то меняет.

Ответы [ 4 ]

16 голосов
/ 24 марта 2011

Блочные комментарии, начинающиеся с /** в java, являются комментариями javadoc. Затмение окрашивает их по-разному, чтобы отличать их от обычных комментариев.

Вот руководство, которое описывает, как писать комментарии к документации для Java: http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html

При наведении указателя мыши на класс / метод / поле с комментарием Javadoc в Eclipse вы увидите небольшое всплывающее окно документации, содержащее отформатированную версию комментария Javadoc для этого класса / метода / поля.

Вы также можете использовать инструмент командной строки javadoc для генерации HTML-документации для ваших пакетов и классов. Когда вы делаете это, инструмент использует комментарии javadoc в вашем исходном коде для создания документации.

5 голосов
/ 24 марта 2011

Комментарий Eclipse по умолчанию:

  • // и /* .. */ являются стандартными комментариями и отображаются в одном цвете, зеленый
  • /** ...... **/ являются javadoc комментариями и отображаются в другом цвете, синий
3 голосов
/ 24 марта 2011

Ничего особенного в этом нет,

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

/ ** ** / означает комментарии JavaDoc

Просто дляразница между ними, даны два разных цвета.

0 голосов
/ 27 мая 2016

Нормальные комментарии, такие как

// this is a comment

показаны зеленым цветом
также похоже на многострочные комментарии, такие как:

/* This can spread out over more than one line.*/

Оба очень полезны, но при использовании метода / класса, в котором они находятся и хотят знать, что он делает, он не будет отображаться при наведении мыши на слово.
К счастью, в Java есть нечто подобное

/** This method creates a display */

Это называется Javadoc.

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...