Perguntas com a marcação «javadocs»

Recentemente, tenho trabalhado na refatoração de partes da base de código com a qual estou lidando atualmente - não apenas para entender melhor, mas também para facilitar para outras pessoas que estão trabalhando no código. Costumo me apoiar no lado de pensar que o código de auto-documentação é bom . …

18 java  documentation  refactoring  javadocs 

Existe um bom termo semelhante, mas diferente de "descontinuar", para significar que um método ou API está na base de código, mas não deve ser usado porque sua implementação não está completa ou provavelmente será alterada? (Sim, eu sei, esses métodos não devem ser públicos, yada yada yada. Eu não …

12 documentation  terminology  api  documentation-generation  javadocs 

No JavaDoc para X509Certificate getSubjectDN()ele afirma: Denegrido , substituído por getSubjectX500Principal (). Estou acostumado a ver Preterido nos métodos que não devem mais ser usados, mas não Denegridos. Eu encontrei um relatório de bug sobre este caso específico, onde foi fechado com o comentário: Isso não é um bug. "Descontinuado" …

11 java  terminology  javadocs 

Estou trabalhando em uma pequena biblioteca que fornece implementações de métricas básicas e bem conhecidas de strings. Principalmente para minha própria educação. Assim, o desenvolvimento acontece sempre que tenho um pouco de tempo livre. Por isso, automatizei a maioria dos processos para poder lançar uma versão sempre que trabalhar nela …

9 java  documentation  javadocs 

Eu quero escrever Javadoc de maneira SECA. Mas o documento da Oracle sobre Javadoc diz que escreva a mesma coisa novamente no comentário do método de sobrecarga. Não posso evitar a repetição?

9 documentation  comments  dry  javadocs 

Acabei de encontrar o seguinte em um manual de laboratório na universidade: Você precisa estudar as interfaces das classes gerando o javadoc para elas para saber quais operações são fornecidas (fique à vontade para olhar o código, mas ao usar o código de outra pessoa, como aqui, você deve trabalhar …

8 source-code  comments  javadocs 

Qual seria uma boa alternativa para a documentação Java embutida, ou seja, é possível ter um arquivo de documentos separado de alguma forma mapeado para um arquivo de origem java? Eu nunca gostei de grandes seções de comentários repletas de código.

8 java  documentation  javadocs