Fechadas. Esta pergunta não atende às diretrizes de estouro de pilha . No momento, não está aceitando respostas. Deseja melhorar esta pergunta? Atualize a pergunta para que ela esteja no tópico do Stack Overflow. Fechado há 3 anos . Melhore esta...
Que convenção você usa para comentar getters e setters? Isso é algo que eu me pergunto há algum tempo, por exemplo: /** * (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) */ public...
Não gosto dos Javadocs padrão gerados para mim quando crio uma Classe ou métodos, especialmente a variável @author, que é o nome de usuário do sistema atual na caixa do Windows. Eu gostaria de mudar isso. Isso é
Se escrevo <xmlElement>em um javadoc, ele não aparece, pois as tags têm funções especiais na formatação de textos. Como posso mostrar esses caracteres em um
Quando estou codificando no Netbeans, ele preenche automaticamente o código e mostra Javadocs. No entanto, quando estou usando o Intellij IDEA, se eu clicar em Ctrl+Space , posso ver o preenchimento automático e se clicar em Ctrl+Q , posso ver o javadoc separadamente. É possível ver o Javadoc do...
Usando o Javadoc 1.5, não consegui criar um @link para um valor de Enumeração. O que eu gostaria de fazer é criar um Enum como este: public enum Planet { /** * MERCURY is a fun place. */ MERCURY, /** * VENUS is more fun. */ VENUS, /** * But nothing beats the Earth. */ EARTH, /** * Others...
Ao criar uma nova classe ou interface no Netbeans IDE, uma tag "@author ...." aparece. Como mudar seu valor? Se possível, gostaria de alterá-lo usando o menu do Netbeans e não editando alguns arquivos de configuração :) Estou usando o Netbeans
Quando devo usar @seepara lidar com JavaDocs? Qual é o seu uso? Por exemplo, se MethodAas chamadas MethodB, em seguida, eu tenho que colocar @seeem MethodB's javadoc e referência MethodAporque é isso que chamou, ou eu tenho que colocar uma referência a MethodBpartir MethodAporque ele está...
É uma prática correta adicionar comentários Javadoc na interface e adicionar comentários não Javadoc na implementação? A maioria dos IDEs gera comentários não JavaDoc para implementações quando você gera comentários automaticamente. O método concreto não deveria ter a...
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 can reference...
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...
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 é...
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
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...
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...
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...