Perguntas com a marcação «javadoc»

Como posso usar a @linktag para vincular a um método? Eu quero mudar: /** * Returns the Baz object owned by the Bar object owned by Foo owned by this. * A convenience method, equivalent to getFoo().getBar().getBaz() * @return baz */ public Baz fooBarBaz() para: /** * Returns the Baz …

864 java  hyperlink  javadoc 

Algo como: /** * See {@linktourl http://google.com} */

768 java  url  javadoc  hyperlink 

Eu tenho um pequeno exemplo de código que quero incluir no comentário do Javadoc para um método. /** * -- ex: looping through List of Map objects -- * <code> * for (int i = 0; i < list.size(); i++) { * Map map = (Map)list.get(i); * System.out.println(map.get("wordID")); * System.out.println(map.get("word")); …

531 java  html  javadoc 

Existe uma maneira de adicionar referências a um ou mais parâmetros de um método no corpo da documentação do método? Algo como: /** * When {@paramref a} is null, we rely on b for the discombobulation. * * @param a this is one of the parameters * @param b another …

313 java  arguments  javadoc 

Desde que eu uso o Maven, fui capaz de criar e instalar em meus projetos de repositório local que possuem tags Javadoc incompletas (por exemplo, um parâmetro ausente). No entanto, desde que eu migrei para o Java 8 (1.8.0-ea-b90), o Maven é absolutamente rigoroso quanto à falta de tags de …

312 java  maven  migration  java-8  javadoc 

A nova versão do plug-in ADT r17 para Eclipse adicionou o recurso para configurar automaticamente as dependências JAR. Todos os arquivos .jar na pasta / libs são adicionados à configuração de compilação agora. Infelizmente, o contêiner do caminho de classe das Dependências do Android não é modificável. Como anexar javadoc …

254 android  eclipse  adt  javadoc 

Atualmente, estou referenciando métodos em outras classes com esta sintaxe Javadoc: @see {@link com.my.package.Class#method()} E pelo que entendi da documentação, esta é a maneira correta de fazer isso. Mas agora para a parte engraçada, ou frustrante. Quando eu gero esse javadoc, recebo o seguinte erro: warning - Tag @see:illegal character: …

238 java  javadoc 

Ao tentar criar comentários Javadoc no nível do pacote, qual é o método preferido? O que você faz? package-info.java Prós Mais recentes Contras Abuso de classe - Classes são para código, não apenas para comentários package.html Prós Extensão HTML significa que não é código Destaque de sintaxe nos editores de …

230 java  javadoc 

Posso usar teclas de atalho no Android studio para gerar comentários javadoc? Caso contrário, qual é a maneira mais fácil de gerar comentários javadoc?

204 android-studio  javadoc 

Qual é a diferença entre /** * comment * * */ e /* * * comment * */ em Java? Quando devo usá-los?

191 java  comments  javadoc 

Alguém poderia me dizer a diferença entre javadoc @seee {@link}? Ou melhor, quando usar qual deles?

184 java  javadoc 

Sei que não é o problema mais importante, mas acabei de perceber que posso colocar o bloco de comentários javadoc antes ou depois da anotação. O que gostaríamos de adotar como um padrão de codificação? /** * This is a javadoc comment before the annotation */ @Component public class MyClass …

184 java  coding-style  annotations  javadoc  code-documentation 

Nas APIs Java, posso ver comentários do Javadoc para pacotes. Como / onde coloco comentários Javadoc para documentar um pacote?

182 java  packages  javadoc 

Como posso escapar do @símbolo no javadoc? Estou tentando usá-lo dentro de uma {@code}tag, que está dentro de <pre>tags. Eu já tentei a @sequência de escape html , mas isso não funcionou.

180 java  escaping  javadoc 

Estou usando o Maven (e a Integração do Maven Eclipse) para gerenciar as dependências dos meus projetos Java no Eclipse. O recurso de download automático de arquivos JAR dos repositórios Maven economiza em tempo real. Infelizmente, ele não inclui a documentação da API e o código-fonte. Como configurar o Maven …

176 eclipse  maven-2  javadoc