Вопросы с тегом 'javadoc'

Javadoc - это расширяемая система генерации документации, которая читает специально отформатированные комментарии в исходном коде Java и генерирует скомпилированную документацию. Он обычно используется для создания документации API в виде веб-страниц HTML.
1

Предлагают ли сторонние сборки JDK Javadocs?

Когда я устанавливаю новый JDK, я следую процедурам, аналогичным описанным здесь. Например, как эта ссылка, я тоже хотел бы иметь локальную копию Javadocs. См. Ссылку "Шаг 7: (Необязательно) Загрузите документацию, демонстрационные материалы и прим...
08 июн. '19 в 4:49
1

Создать и создать Javadoc из IDE?

Я написал этот Javadoc в своих классах моего проекта: /** Description ... @param ... @return ... @author ... */ Что я должен сделать, чтобы создать Javadoc HTML из Eclipse?
23 дек. '16 в 13:24
1

Как достичь возврата каретки/разрыва строки в doctags

Я хочу поместить эти данные через Javadoc: /** * 1. line * * 2. line */ Как я могу заставить Javadoc поместить их в отдельные строки, например: 1. линия 2. линия Прямо сейчас, Javadoc объединяет их, вот так: 1. линия 2. линия
04 мар. '17 в 6:29
2

отсутствующая деталь javadoc в intelliJ

Просто переключите IDE из Eclipse в intelliJ, когда я использую ctrl + q, чтобы попытаться выставить больше объяснений для метода, он не покажет никаких подробностей. Как я могу исправить это, чтобы получить ту же информацию, что и Eclipse?
04 сент. '17 в 3:06
3

Соглашение об именах для переменной java final, которая не является статической

У меня есть метод в классе java. public void myMethod() { final String methodName = "myMethod"; } Когда я запускал этот код с помощью анализа в сонаре, у меня возникает вопрос: Переименуйте это имя константы в соответствие с регулярным в...
25 сент. '17 в 14:04
3

Нужно ли мне javadoc использовать каждый метод или только "основной" метод в java?

Метод примера Java: //Stores the user input into an integer variable called 'choice' int choice = keyboard.nextInt(); Нужно ли писать javadoc для простого метода, подобного этому, или я должен только документировать основной метод любой программы,...
02 дек. '09 в 18:23
1

Проверьте неправильное использование углового кронштейна (не в тегах) во встроенном Javadoc в IntelliJ IDEA

Довольно простой вопрос: я часто забываю, что использование символов Javadoc меньше, чем и больше , не работает без использования литерального блока или < qaru.site/questions/71198/... , поскольку они рассматриваются как теги форматирования. ...
07 янв. '18 в 4:52
1

Как использовать JavaDoc?

это мой первый раз, используя javadoc. Моя проблема в том, что она просто показывает мне первый метод "public static void main", все остальные комментарии javadoc не отображаются после создания документа. Что я делаю не так? Спасибо вам всем! Вот...
21 мая '14 в 15:25
1

Как сделать JAVADOC моей программы?

Это мой код: public class Client { protected int cod; protected String name; public void setCod(int cod) throws Exception { if(cod==null) throw new Exception("Invalid code!"); this.cod = cod; } public int getCo...
17 дек. '17 в 23:52
1

Для комментариев java doc как правильно комментировать метод void?

Я знаю методы с параметрами и конструкторами, вы делаете @param или @return, но как вы ссылаетесь на метод void в java-документах?
25 янв. '18 в 15:30
2

Как должен быть документирован параметр основного метода

Как я должен документировать параметр следующего метода? public static void main (String[] args) throws IOException Должен ли я использовать @param?
29 дек. '15 в 21:47
1

Редактирование полей в Javadoc IntelliJ

Я новичок в java, и для одного из моих заданий я изучаю, как добавлять информацию для методов в каждом из моих классов. Я использую редактор идей IntelliJ.
17 окт. '15 в 6:04
1

Как создать Javadoc?

Я хочу создать javadoc в eclipse, но у меня нет файла C:\JBuilderX\jdk1.8\bin\javadoc.exe. для командного пути. Пожалуйста помоги!
23 авг. '15 в 17:29
0

Этот javadoc и Документация достаточно хороши для университета?

мне нужно написать документацию по javadoc и внутренним методам, и я сделал, но я хочу проверить, можете ли вы улучшить ее, она должна быть на академическом уровне: /** * actions method calculates the minimum actions neede to reach from x to y (...
11 мая '19 в 14:01