Vídeo: Programar em Java - Fazer Comentários - Aula 3 2024
Esta lista de Java tem uma versão aprimorada de um programa de exemplo. Além de todas as palavras-chave, identificadores e pontuação, tem texto destinado a seres humanos para ler.
/ * * Listagem 3-6 em "Java For Dummies, 6th Edition" * * Copyright 2014 Wiley Publishing, Inc. * Todos os direitos reservados. * / / ** * A classe Displayer exibe texto * na tela do computador. * * @author Barry Burd * @version 1. 0 10/24/13 * @see java. lang. System * / public class Displayer {/ ** * O método principal é onde * a execução do código começa. * * @param args (Consulte o Capítulo 11.) * / public static void main (String args []) {System. Fora. println ("Eu amo Java!"); //EU? Você?}}
Um comentário é uma seção especial de texto dentro de um programa cujo objetivo é ajudar as pessoas a entender o programa. Um comentário faz parte da documentação de um bom programa.
A linguagem de programação Java tem três tipos de comentários:
-
Comentários tradicionais: As primeiras cinco linhas da listagem formam um comentário tradicional . O comentário começa com / * e termina com * /. Tudo entre a abertura / * e o fechamento * / é apenas para olhos humanos. Nenhuma informação sobre "Java For Dummies, 6th Edition" ou Wiley Publishing, Inc. é traduzida pelo compilador.
A segunda, terceira, quarta e quinta linhas no Listado 3-6 possuem asteriscos extras (*). Eles são chamados de extra porque esses asteriscos não são necessários quando você cria um comentário. Eles apenas fazem o comentário parecer bonito.
-
Comentários de fim de linha: O texto // I? Você? na listagem é um fim de linha comentário. Um comentário de fim de linha começa com duas barras e vai ao final de uma linha de tipo. Mais uma vez, o compilador não traduz o texto dentro do comentário de fim de linha.
-
Comentários de Javadoc: A javadoc o comentário começa com uma barra e dois asteriscos (/ **). A lista tem dois comentários javadoc - um com o texto A classe Displayer … e outro com o texto O método principal é onde ….
Um comentário javadoc é um tipo especial de comentário tradicional. Um comentário javadoc deve ser lido por pessoas que nunca sequer olham o código Java. Mas isso não faz sentido. Como você pode ver os comentários do javadoc?
Bem, um determinado programa chamado javadoc (o que mais?) Pode encontrar todos os comentários javadoc na listagem e transformar esses comentários em uma página da web bonita. Esta figura mostra a página.
Os comentários de Javadoc são ótimos. Aqui estão várias coisas excelentes sobre eles:
-
A única pessoa que tem que olhar para um pedaço de código Java é o programador que escreve o código.Outras pessoas que usam o código podem descobrir o que o código faz ao visualizar a página da Web gerada automaticamente.
-
Como outras pessoas não observam o código Java, outras pessoas não fazem alterações no código Java. (Em outras palavras, outras pessoas não introduzem erros no código Java existente.)
-
Como outras pessoas não observam o código Java, outras pessoas não precisam decifrar o funcionamento interno do código Java. Todas essas pessoas precisam saber sobre o código é o que eles lêem na página da web do código.
-
O programador não cria duas coisas separadas - algum código Java aqui e alguma documentação sobre o código lá. Em vez disso, o programador cria uma peça de código Java e incorpora a documentação (na forma de comentários javadoc) dentro do código.
-
O melhor de tudo, a geração de páginas da Web a partir de comentários javadoc é automática. Assim, a documentação de todos tem o mesmo formato. Independentemente do código Java que você use, você entende sobre esse código lendo uma página como a da figura. Isso é bom porque o formato é familiar para quem usa o Java.
