Como você escreve um comentário javadoc?
Sintaxe
Em primeiro lugar, precisamos ver a sintaxe básica dos comentários javadoc em java. Então, estamos usando o editor simples para colocar alguns comentários javadoc e exibir a apresentação abaixo na imagem anexada. O comentário autogenerado do documento Java começa com um personagem especial como um asterisco, e a primeira linha de todo o comentário pode ser uma cor verde. Você pode ver a representação de um comentário de documento Java que tem muitos personagens de asteriscos no início de cada comentário do começo ao fim.
No início, o comentário do Java Doc começa com o personagem "/" seguido por dois caracteres de asteriscos. Ao mesmo tempo, todas as outras linhas contêm um único caractere de asterisco no início. No final de um comentário de documento Java, terminamos com o personagem "/". Entre esta ilustração do comentário do documento Java, você verá uma linha de comentários "7", onde definimos o nome de um autor usando o caractere "@" para definir uma variável "autor" com o nome de um autor, eu.e., Saeed Raza. As informações dos metadados dos comentários do documento Java devem sempre ser escritos com o personagem "@".
Crie comentário automático de Doc Java no Eclipse IDE
Este exemplo usa o ambiente de desenvolvimento Java Eclipse IDE para criar comentários automáticos no projeto Java. Para isso, você deve ter um IDE eclipse montado e configurado no seu fim. Então, inicie o IDE do Eclipse e tente criar um novo projeto chamado "Java". Ele solicitará que você nomeie o pacote atual do projeto. Nós o chamamos de "java" também. Depois disso, você precisa criar um novo arquivo Java ou criar uma nova classe no mesmo projeto Java. Para isso, reproduza à direita no nome do pacote do canto esquerdo da barra exploradora do Projeto Eclipse IDE, vá para a opção "nova" e pressione a palavra-chave "classe" das opções expandidas. Isso gerará uma nova janela na tela com o título "New Java Class", conforme exibido na imagem abaixo.
Agora, você precisa inserir o nome de uma classe a ser criada dentro da caixa de texto em frente ao rótulo "nome". A maioria das coisas ficará inalterada, pois elas foram selecionadas automaticamente sempre que você tentar criar uma nova classe. Você só precisa limpar o final do método que deseja criar para o seu código Java. Portanto, verificamos a primeira caixa de seleção para criar uma função de driver principal () nesta classe. Por último, mas não menos importante, você encontrará uma oportunidade de adicionar os comentários padrão no programa Java a ser criado. Você só precisa marcar a caixa de seleção chamada "Gerate Comentários". Este será um passo fenomenal na criação do código Java. Vamos apertar o botão "Acabamento" depois de fornecer todas as informações necessárias.
O programa Java mostrado-Below foi criado na ferramenta Eclipse IDE, juntamente com comentários automáticos. Você pode ver que os comentários do Doc Java começaram com os personagens de asteriscos. Ele também fornece informações de metadados sobre o projeto, eu.e., o autor. Junto com isso, também mostra que o comentário automático mostra que criamos uma função principal de stub também. É tudo sobre a geração automática de comentários javadoc no eclipse ide.
Exemplo 01: Comentários Javadoc
Agora, você pode criar seus próprios comentários de documentos Java enquanto codificam. Aqui está outra ilustração para fazer isso. Sempre que você está usando a função de driver principal () no código, eu.e., Você deveria estar usando-o em todos os programas, sempre deve criar seu comentário na parte superior do arquivo ou, nessa função, iniciar como “// TODO GEERATEADO METHOL STUB”. Este comentário explica que o método principal () foi gerado automaticamente, eu.e., você não precisa escrever.
Depois disso, adicionamos um Javadoc Long Comment elaborando o uso deste programa junto com suas informações de metadados, eu.e., autor, versão e a data em que foi criada. Antes da declaração "println", há uma única linha de comentários usados para explicar o objetivo de usar a função println (). É isso para este exemplo.
A execução de programas com comentários não afeta a saída como abaixo.
Exemplo 01: Comentários de linha única e multilina
Depois de passar pelos comentários do Javadoc no Eclipse IDE, vamos começar a dar uma olhada em outro exemplo de java utilizando os comentários de linha única e de várias linhas, eu.e., usuário definido. Agora geramos uma nova classe "teste" e incluímos o método principal (). Este método contém uma instrução PRIMLN () para exibir algo. Utilizamos um comentário de linha única com o nome de uma aula começando com caracteres "//", eu.e., explica que é inicialização de classe. Na linha de definição de função Main () adicionou um comentário de várias linhas começando com os caracteres "/*" e terminando com os caracteres "*/".
Conclusão
Este artigo ajuda a entender a importância e a vitalidade dos comentários usados na vida cotidiana e na vida de programação. Ele discute como esses comentários podem ajudá -lo de várias maneiras. Em primeiro lugar, discutimos quais são os comentários do Javadoc e explicamos sua sintaxe muito brevemente. Depois disso, explicamos todo o método no Eclipse IDE para gerar os comentários javadoc automáticos dentro de alguns segundos e com alguns cliques na GUI.