[Notas java super invencíveis e detalhadas de Han Shunping] Do iniciante ao proficiente --- Comentários

1. Introdução às anotações

O texto usado para anotar e explicar o programa é um comentário. Os comentários melhoram a legibilidade (legibilidade) do código; os comentários são bons hábitos de programação que um programador deve ter. Organize suas idéias primeiro por meio de comentários e, em seguida, use o código para refleti-las. Existem três tipos de anotações em Java:

2. Tipo de comentário

Comentário de linha única //: // Texto do comentário
Comentários de várias linhas /* */: /* Texto do comentário */
Comentários da documentação /** */

PS: Selecione a parte a ser comentada, pressione ctrl+shift+/ para comentar ou preencha a entrada /** +tab para completar automaticamente

Comentário de linha única:
Indicado por //, adicione conteúdo de comentário após //.

// 这是一个单行注释，用来解释该行代码的作用
int a = 10; // 这也是一个单行注释，用来解释该语句的作用

Comentários de várias linhas:
Indicado por /.../ , várias linhas de conteúdo podem ser adicionadas ao comentário. (não pode ser aninhado)

/* 这是一个多行注释，
   用于解释以下代码的作用 */
int a = 10;

Notas de documentação:
O conteúdo da anotação pode ser analisado pelo Javadoc, ferramenta fornecida pelo JDK, para gerar um conjunto de documentação para o programa na forma de um arquivo de página web, geralmente escrito na classe
Representado por /**...*/, usado para gerar documentação da API. Os comentários da documentação contêm descrições e parâmetros de classes, métodos, etc.

/**
 * @author choclin
 * @version 1.0

 */
	public class  Comment02{
		public static void main(String[] args){
			System.out.println("读书");
		}
	}

D:\Arquivos de programas\java\javacode>javadoc -dd:\\temp -author -version Comment02.java

etiqueta javadoc
Rótulo	descrever	Exemplo
@autor	Identificar o autor de uma classe	@autor choclin
@descontinuada	Especifica uma classe ou membro expirado	@choclin obsoleto
{@docRoot}	Especifica o caminho para o diretório raiz do documento atual	Caminho de diretório
@exceção	Sinaliza uma exceção lançada por uma classe	@exception explicação do nome da exceção
{@heritDoc}	Anotações herdadas da classe pai direta	Herda um comentário da superclasse imediata.
{@link}	Insira um link para outro tópico	(@texto do nome do link)
{@linkplain}	Insira um link para outro tema, mas o link exibe texto simples em fontes de madeira	Insere um link in-line para outro tópico.
@param	Descreva o número de conjuntos de um método	@param explicação do nome do parâmetro
@retornar	Descrever o tipo de valor de retorno	@return explicação
@ver	Especifique um link para outro tópico	@ver âncora
@serial	Descreve uma propriedade de serialização	@descrição serial