Introdução
Comentários - parece que poderia ser mais simples, e por que escrever um artigo inteiro. Mas não é tão simples. Como disse meu chefe, qualquer um pode escrever código, mas escrever um bom comentário é difícil. A maioria dos cursos de idiomas começa com o tradicional Hello World. Mesmo nos Tutoriais Oracle, na seção "Introdução", começamos com o "Hello World!" Aplicativo . E desde as primeiras linhas de código nós os vemos - comentários Java. Sua importância também é enfatizada pelo fato de que em um documento tão importante como a Convenção do Código Java, os comentários recebem uma seção separada: Comentários . De acordo com a documentação, os comentários em Java são divididos em dois tipos:- comentário de implementação (ou comentário de código);
- documentando comentário.
Comentários do código Java
Pelo nome fica claro que este comentário está relacionado ao código e deve refletir suas características. Os comentários do código são:-
Minúsculas (ou seja, descritas em uma linha)
// Строчный комментарий System.out.println("Hello, World!");
-
Bloco (ou seja, são descritos como um bloco inteiro, porque não cabem em uma linha)
/* * Блочный комментарий */ System.out.println("Hello");
Cada vez que você comenta, estremece e se sente um fracasso."É claro que não existe verdade absoluta e às vezes são necessários comentários. Mas sempre há opções e é preciso combater comentários desnecessários. Este capítulo também menciona comentários incomuns, TODO:
// TODO: Добавить World
System.out.println("Hello, ");
A questão é que eles podem ser tratados de uma maneira especial no IDE. Por exemplo, no IDEA eles são coletados em uma guia separada, onde você pode visualizá-los:
Comentários para documentação
Os comentários da documentação descrevem a API pública. API é a interface de programação da aplicação, ou seja, aquelas classes e métodos que estão disponíveis para outros desenvolvedores realizarem quaisquer ações. Resumindo, esses comentários devem explicar por que esta ou aquela classe e pacote foram criados e o que este ou aquele método faz. Você também pode descrever campos de classe, se necessário. Isso é exatamente o que vemos nas dicas de nossos IDEs, que estão formatados como JavaDoc. Por exemplo:package test;
/**
* This is a JavaDoc class comment
*/
public class JavaDocTest {
/**
* This is a JavaDoc public field comment
*/
public static final String HELLO_MESSAGE = "Hello, World!";
public static void main(String... args) {
JavaDocTest.greetings();
}
/**
* This is a JavaDoc public method comment
*/
public static void greetings() {
System.out.println(HELLO_MESSAGE);
}
}
Depois disso, podemos executar o seguinte comando a partir do diretório que contém nosso diretório de pacotes: javadoc -d ./test test
Depois disso, veremos o processo de geração da documentação.
Conclusão
Como podemos ver, algo aparentemente simples como os comentários acaba sendo muito mais complicado na realidade. Portanto, se você dedicar algum tempo aos comentários e segui-los, seu código ficará melhor e você será mais valioso como programador. #ViacheslavO que mais ler: |
---|
GO TO FULL VERSION