Comentários são uma ferramenta poderosa. Eles podem ser usados ​​para gerar toda a interface de programação de aplicativo (API) documentações com ferramentas como o javadoc , dar pequenas dicas em partes complicadas de código, ou simplesmente descrever o que o código está prestes a fazer. Quando você deixar um comentário no código Java, você também pode mostrar um leitor que não conhece a linguagem exatamente o que o código está fazendo . Instruções
1

Deixe suma, comentários de linha única para dizer alguma coisa rapidamente, antes que um pequeno grupo de linhas. Pequenos comentários delinear o que está sendo feito , em geral, "pedaços ". Um programador , muitas vezes, escrever estes comentários antes de voltar a preencher o código depois, ajudando-o a consolidar sua imagem mental de como o código irá funcionar antes de escrevê-lo, bem como identificar eventuais falhas na lógica antes de escrever o código.
Página 2

Conheça o formato para deixar comentários de uma linha . Eles são conhecidos por "//" " " //Conectar-se à serverSocket s = new TcpSocket (); s.connect . ( "Example.com" , 80) ;//Solicite o files.write ( " GET /HTTP /1.0 \\ r \\ n \\ r \\ n "); resposta string = s.read ( ) ;//foi o pedido bem sucedido código int = get_code (resposta) ; ! if ( code = 200 ) return -1 ;//Download o filedownload_file (s) "; "
3

Use multi- linha comenta quando você tem mais a dizer do que vai caber em uma única linha. Comentários de várias linhas são normalmente encontrados no topo de métodos que descrevem função geral , como funciona e quais os parâmetros que leva. Eles também visto , por vezes, em partes localizadas do código o programador teve problemas com ou pensa mandado discussão aprofundada .
4

Observe o formato geral de comentários multi- linha . Por convenção, cada linha começa com um asterisco. Os únicos requisitos formato específico são de que o comentário começa com /* e termina com * /" . " /* Esta parte foi muito difícil . Eu tive que cortar * este valor para se encaixar com os outros. * Talvez eu vou voltar a este código para * encontrar uma maneira melhor de fazer isso , mas para * agora isso funciona, mas não é bonito . * /" "
5

saber o formato de comentários Javadoc . Eles começam com /** e conter meta-tags que se parecem com @ isso. Comentários Javadoc são encontradas principalmente antes de métodos. "" /*** Calcula a inclinação de uma linha . ** @ Autor Jack Smith * @ param p1 Primeiro ponto que descreve a linha * @ param p2 Segundo ponto que descreve o Slope linha * @ return da linha como um float * /" "