É muito importante que os desenvolvedores do programa anexem comentários ao código. Com o desenvolvimento da tecnologia, os programadores devem ser obrigados a escrever comentários de código durante o desenvolvimento do projeto, o que é propício à escrita e uso subsequentes do código.
Requisitos básicos:
1. Formulário de comentário unificado
Durante o aplicativo, use estilos com pontuação e estrutura consistentes para construir anotações. Se você achar que as especificações da anotação são diferentes deste documento em outros projetos, escreva código de acordo com esta especificação e não tente introduzir novas especificações no sistema de especificação estabelecida.
2. O conteúdo do comentário é preciso e conciso
O conteúdo deve ser simples, claro e preciso, e o significado deve ser impedido de ambiguidade dos comentários. Comentários incorretos não são apenas inúteis, mas também prejudiciais.
3. Comentários básicos (devem ser adicionados)
(a) Comentários para a classe (interface)
(b) Comentário do construtor
(c) Comentários sobre métodos
(d) Comentários de variáveis globais
(e) Notas para campos/atributos: o código simples faz comentários simples, o conteúdo do comentário não passa mais de 10 palavras e, além disso, persiste objetos ou
Os métodos Getter e Setter dos objetos VO não precisam ser comentados. Para formatos específicos de anotação, consulte os exemplos a seguir.
4. Comentários especiais devem ser adicionados (devem ser adicionados)
(a) Os algoritmos típicos devem ser comentados.
(b) Os comentários devem ser feitos em código pouco claro.
(c) Adicione um comentário à marca de modificação na modificação do código.
(d) Comente no código composto por loops e ramificações lógicas.
(e) As interfaces fornecidas a outras pessoas devem ser comentadas em detalhes.
Nota: Não há exemplos para esse tipo de formato de comentário. O formato de anotação específico é definido por si mesmo e o conteúdo da anotação é necessário para ser preciso e conciso.
5. Formato de comentário:
1) Comentário de linha única: "// ..."
2) Comentário do bloco: "/*…*/"
3) Comentários do documento: "/**…*/"
4) Sintaxe de tag de comentário javadoc
@Author A descrição da classe indica o autor que desenvolveu o módulo da classe
@Version A descrição da classe indica a versão do módulo da classe
@See Referência Vire à descrição de classes, propriedades e métodos, ou seja, tópicos relacionados
@param Descrição do método Descrição de um parâmetro em um método
@return Descrição do método Descrição do método Valor de retorno
@Exception Descrição do método Descrição de exceções que podem ser jogadas pelo método
6. Exemplo:
/** Crie uma classe de ferramentas para manipular matrizes, que contém essa função comum para as matrizes de operação: o maior valor. @author zhang san @versão v. */ public class Arraytool {/ ** Obtenha o valor máximo da matriz de modelagem @param arr recebe uma matriz de elementos do tipo int @return o valor máximo do elemento da matriz */ public int getMax (int arr) {int max =; retornar max; }}Digite o comando como mostrado na figura abaixo:
Em seguida, verifique no diretório a seguir e, finalmente, clique em index.html:
O conteúdo acima compartilha especificações de comentários do código Java com você, esperando que seja útil para você.