Gerador de modelo Javadoc [fechado]

Question

Eu tenho uma grande base de código sem Javadoc e quero executar um programa para escrever um esqueleto com as informações básicas do Javadoc (por exemplo, para o parâmetro de cada método, escreva @param...), então só preciso preencher as lacunas restantes.

Alguém conhece uma boa solução para isso?

Editar:

JAutodoc é o que eu estava procurando.Possui tarefas Ant, um plugin Eclipse e usa Velocity para a definição do modelo.

Answer 1

O JAutodoc plugin para Eclipse faz exatamente o que você precisa, mas com granularidade de pacote:

clique com o botão direito em um pacote, selecione "Adicionar javadoc para membros..." e o esqueleto será adicionado.

Existem inúmeras opções interessantes:modelos para javadoc, adicionando um TODO no cabeçalho de cada arquivo dizendo:"modelo javadoc, deve ser preenchido...", etc.

Answer 2

Acho que a geração automática de Javadoc vazio é um antipadrão e deve ser desencorajado;dá ao código a aparência de estar documentado, mas apenas adiciona ruído à base de código.

Em vez disso, eu recomendaria que você configurasse seu editor de código para ajudar por método e por classe para usar quando você realmente escreve o javadoc (um comentarista apontou para o recurso do Eclipse que faz isso).

Answer 3

Você também pode colocar o cursor na linha acima de um método que deseja JavaDoc e digitar:

/**

e pressione Enter.Isso irá gerar seu stub JavaDoc.

Answer 4

Você pode configurar o Eclipse para mostrar avisos para coisas que não possuem javadoc, ou possuem javadoc que não possui todas as informações ou possuem informações erradas.Também pode inserir modelos para você preencher.

Não é exatamente a ferramenta que você pediu, mas provavelmente é melhor porque você não acabará com esqueletos vazios em métodos que perdeu.

Você pode conseguir isso investigando e editando a página de preferências além do caminho Window > Preferences > Java > Compiler > Javadoc para sua área de trabalho.A captura de tela dessa página de preferências está abaixo:

Para mais informações sobre os itens desta tela, siga o link abaixo:

Ajuda das preferências do Javadoc do compilador Java

Answer 5

Selecione o método que você deseja adicionar Javadoc e alternativo+Mudança+j, cria automaticamente o comentário javadoc.

EXEMPLO:

/**
     * @param currDate
     * @param index
     * @return
     */
    public static String getAtoBinary(String currDate, int index){  
        String HourA = "0";
        try{
            String[] mydate = currDate.split("/");
            HourA = mydate[index].substring(1, 2);
        }catch(Exception e){
            Log.e(TAG, e.getMessage());
        }
        return HourA;
    }

Answer 6

Se você clicar com o botão direito na origem de um arquivo no Eclipse, ele terá uma opção de geração de Javadoc no menu de origem.