• Documentação de um atributo

A documentação do atributo é feita na linha anterior à sua definição e é feita no seguinte formato:

• Documentação de um método

A documentação de um método tem por objetivo fornecer uma descrição sucinta, mas suficiente para conhecer o que a função faz, o que ela deve receber como parâmetros e qual seu valor de retorno. Recomenda-se que a descrição comece sempre por um verbo (Busca, Procura, Move, Altera, Edita, etc.) que indique a ação efetuada pelo método. A documentação do método é feita no seguinte formato:

        /**
        * <descrição do método>
        *
        * @param <nome_do_parâmetro> <descrição>
        *
        * @return <descrição do valor de retorno>
        */
        

A documentação de métodos construtores é feita da mesma forma que para os demais métodos, entretanto não é utilizada a tag @return, visto que o construtor nunca possui valor de retorno.