[IDEA] Как каментить методы, чтобы легко его вызывать в тексте?

bastii

Т.е. как, в каком месте относительно декларации/реализации метода можно сделать камент, чтобы потом, встретив этот метод в тексте проги, можно было легко и быстро (как это делается?) вызвать этот камент (например, вызвать подсказку с этим каментом)?

livemix

Набираешь в коде слово Object, становишься на него курсором, нажимаешь Ctrl+B, видишь текст класса java.lang.Object. В этом тексте можно посмотреть как писать комменты. Чтобы вызвать коммент, надо нажать Ctrl+Q

ifani

что-то я вопрос не понял
Ты спрашиваешь, в каком месте явадоки пишутся?
Перед методом. Например, так:

/**
* Установление значения поля
* @param fieldNum поле
* @param value значение
* @param display как значени будет выглядеть в коде
*/
public void setFieldValue(int fieldNum, Object value, String display)
{
if(curManager!=null)
{
curManager.setFieldValue(fieldNum, value, display);
}
}

потом где-нить в коде можно на вызове этого метода нажать ctrl+Q и комменты покажутся

ifani

мда, выравнивание совсем отъехало%)
в Идее, кстати, если если перед методом набрать /** и потом нажать enter, то она тебе сама явадоки составит;)

bastii

Просто помню, что в то ли в VS+Visual Assist, то ли еще где была такая фича, что если перед методом поместить камент, то при наведении курсора на метод в тексте появляется подсказка с этим каментом. Было очень удобно.

bastii

Мне нужно каментить для себя, внутренний код, приватные методы.

ifani

ну вот как раз так и будет%)
только не просто курсор навести, а ещё пару кнопочек нажать%)

ifani

ну, для приватных методов это тоже подходит
а вот как ты себе представляешь просмотр комментов внутри метода?

bastii

а вот как ты себе представляешь просмотр комментов внутри метода?

Не понял что ты спрашиваешь?
Ладно, похоже придется Джава документироваться.

ifani

ну, это я к тому, что комменты перед методом можно посмотреть, наведя курсор на метод в месте его вызова
а в каком месте ты хочешь смотреть комменты внутреннего кода? тоже наведя курсор на вызов метода?

bastii

Под внутренним кодом я имел в виду, что не для джава-доков.

ну, это я к тому, что комменты перед методом можно посмотреть, наведя курсор на метод в месте его вызова

Перейдя к объявлению?

ifani

Перейдя к объявлению?

Зачем?
Вот так выглядит просмотр инфы по методу, описанному выше:

bastii

Это по Ctrl+Q? Это с юзанием джава доков? Появляется только после их генерации?
Я написал камент, у меня джава доки не настроены и не генерируются, и ничего не показывается по Ctrl+Q.

Hastya

не надо никакой генерации
RTFM

bastii

Ага. Все показывает. Видимо я не на тот метод вызывал.
В общем, всем спасибо.

voronetskaya

фии, каменты на русском :-\ афтар, учи албанский