Вопросы с тегом «javadoc»

Я написал комментарии в стиле Javadoc следующим образом в коде моего проекта: /** * Description... * * @param ... * @return ..... */ Как создать HTML-файлы Javadoc с помощью Eclipse IDE?

165 java  eclipse  javadoc 

Я просматривал документацию javadoc на сайте Sun, пытаясь найти, есть ли тег javadoc, который можно использовать для документирования сигнатуры общего типа класса или метода. Нечто подобное @typeparam, похожее на обычное @param, но применимое к типам, а также к методам, например /** * @typeparam T This describes my type parameter */ …

165 java  javadoc 

Закрыто . Этот вопрос основан на мнении . В настоящее время он не принимает ответы. Хотите улучшить этот вопрос? Обновите вопрос, чтобы ответить на него фактами и цитатами, отредактировав этот пост . Закрыто 2 года назад . Улучшить этот вопрос В настоящее время я начинаю с Python и имею большой …

162 python  documentation  javadoc  docstring 

Я недавно перешел из Eclipse в Android Studio, и мне это нравится. Тем не менее, я скучаю по Javadoc при наведении курсора из Eclipse. Я следовал приведенным здесь инструкциям, чтобы добавить функциональность, однако мои парящие не содержат Javadoc. Если я использую ярлык своей документации Ctrl+ Shift+, Spaceон покажет документацию правильно, …

160 android  android-studio  intellij-idea  javadoc 

Я хочу изменить автоматического автора, который появляется при создании файла в AndroidStudio. /** * Created by a556520 on 16/01/14. */ public class POI { Автор берет «a556520», но я хочу, чтобы появилось мое имя, а не номер сотрудника. Это возможно? Я не нашел в настройках.

153 java  android  android-studio  javadoc 

В Eclipse я могу нажать Alt+ Shift+ Jи получить автоматически генерируемый комментарий javadoc с полями, возвратами или чем-то еще, что будет применимо для этого конкретного комментария javadoc. Я предполагаю, что IntelliJ IDEA имеет эту функцию. Может кто-нибудь сказать мне, есть ли сочетание клавиш для этого?

150 intellij-idea  keyboard-shortcuts  javadoc 

Закрыто. Этот вопрос не соответствует рекомендациям по переполнению стека . В настоящее время он не принимает ответы. Хотите улучшить этот вопрос? Обновите вопрос, чтобы он соответствовал теме Stack Overflow. Закрыт 3 года назад . Уточните этот вопрос есть хороший пример исходного файла, содержащего Javadoc ? Я могу найти много хороших …

142 java  javadoc 

Какое соглашение вы используете для комментирования геттеров и сеттеров? Вот то, что я задумывался довольно давно, например: /** * (1a) what do you put here? * @param salary (1b) what do you put here? */ public void setSalary(float salary); /* * (2a) what do you put here? * @return (2b) …

125 java  comments  javadoc  setter  getter 

Мне не нравятся Javadocs по умолчанию, сгенерированные для меня, когда я создаю класс или методы, особенно переменную @author, которая является текущим системным именем пользователя в моем окне Windows. Я хотел бы это изменить. Это возможно?

124 java  eclipse  templates  javadoc 

Используя Javadoc 1.5, мне не удалось создать ссылку @ на значение перечисления. Я хотел бы создать такой Enum: public enum Planet { /** * MERCURY is a fun place. */ MERCURY, /** * VENUS is more fun. */ VENUS, /** * But nothing beats the Earth. */ EARTH, /** * …

121 java  javadoc 

Если я пишу <xmlElement>в javadoc, он не отображается, потому что теги имеют специальные функции по форматированию текста. Как я могу показать эти символы в javadoc?

121 java  javadoc 

Когда я кодирую в Netbeans, он автоматически заполняет код и показывает Javadocs. Однако, когда я использую Intellij IDEA, если я нажимаю Ctrl+,Space я вижу автозаполнение, а если я нажимаю Ctrl+,Q я вижу javadoc отдельно. Можно ли увидеть Javadoc элемента всякий раз, когда я вижу автозаполнение или нажимаю Ctrl+Space в Intellij …

120 autocomplete  intellij-idea  javadoc 

При создании нового класса или интерфейса в IDE Netbeans появляется тег «@author ....». Как изменить его значение? Если возможно, я хотел бы изменить его, используя меню Netbeans, а не редактируя некоторые файлы конфигурации :) Я использую Netbeans 7.2

113 netbeans  javadoc  netbeans-7 

Когда использовать @seeпри работе с JavaDocs? Каково его использование? Например , если MethodAвызовы , MethodBто я должен поставить @seeв MethodBJavadoc «s и ссылки , MethodAпотому что это то , что называется, или я должен поставить ссылку на MethodBиз , MethodAпотому что звонит его. Я читал материал @seeна веб-сайте Oracle, и …

110 java  methods  javadoc 

Правильно ли добавлять комментарии Javadoc в интерфейс и добавлять комментарии не Javadoc в реализацию? Большинство IDE генерируют комментарии, отличные от JavaDoc, для реализаций, когда вы автоматически генерируете комментарии. Разве у конкретного метода не должно быть описания?

109 java  interface  comments  javadoc