Perguntas com a marcação «javadoc»

Usando JavaDoc, como posso fazer referência ao valor de um campo estático final na classe? Quero que ???neste exemplo seja substituído pelo valor do campo STATIC_FIELD. /** * This is a simple class with only one static field with the value ???. */ public class Simple { /** * We …

96 java  documentation  javadoc 

Muitas vezes me encontro com um dilema ao escrever javadoc para propriedades / membros de uma classe POJO "simples" contendo apenas propriedades e getters e setters (estilo DTO) .... 1) Escreva javadoc para a propriedade ou ... 2) Escreva javadoc para o getter Se eu escrever javadoc para a propriedade, …

93 java  javadoc 

Estou migrando do Eclipse para o Intellij Idea. Uma coisa que não consegui descobrir ainda é o preenchimento automático da @authortag JavaDoc. Ao digitar @ano Eclipse, existem duas propostas: @author - author name @author Como faço para conseguir a primeira proposta no Intellij (isso é possível?)? E se for possível, …

93 intellij-idea  javadoc 

Suponha que, como parte da documentação de seu código (Javadoc), você deseja indicar que as relações entre os elementos usam recuo profundo. Como posso criar uma lista aninhada como: algum elemento algum outro elemento ainda algum outro elemento

88 documentation  javadoc  indentation  nested-lists 

Eu examinei a referência JavaDoc e, embora eu entenda a diferença básica entre @see(vários links) e {@inheritDoc}(exportação do comentário JavaDoc da superclasse), preciso de esclarecimento sobre como as coisas realmente são implementadas. No IDE Eclipse, quando eu seleciono “Gerar comentários de elemento” para o método herdado (da interface ou substituição …

87 java  javadoc  comments 

Exit code: 1 - javadoc: error - The code being documented uses packages in the unnamed module, but the packages defined in https://docs.oracle.com/en/java/javase/11/docs/api/ are in named modules. Alguém conseguiu fazer o javadoc funcionar sem precisar alterar a versão de origem para 1.8 (conforme sugerido em outros fóruns)? Estou usando o …

13 java  maven  javadoc  java-11  maven-javadoc-plugin 

Como se deve documentar os parâmetros do Java Record ? Estou me referindo aos parâmetros que acabam se tornando parâmetros construtores, campos de classe. Eu tentei: /** * @param name the name of the animal * @param age the age of the animal */ public record Animal(String name, int age) …

12 java  intellij-idea  javadoc  java-14  java-record