Wulin.com (www.vevb.com) Introdução ao artigo: Nunca vi nenhuma pesquisa científica provar isso, mas no campo de software, é como um dogma ou uma crença comum. Devido à sua existência, é importante escrever software facilmente e prestar atenção ao tipo legível de código. Esses requisitos podem ser alcançados através de algumas técnicas, uma das quais está escrevendo comentários de código.
Isenção de responsabilidade: o que eu disse sobre como evitar comentários de código não significa que não escrevo comentários, o que significa que evito escrever comentários do código o máximo possível, mas ainda os escrevo quando sinto que vale a pena.
Passamos mais tempo lendo o software do que escrita de software e nunca vi nenhuma pesquisa científica provar isso, mas no campo de software, é como um dogma ou uma crença comum. Devido à sua existência, é importante escrever software facilmente e prestar atenção ao tipo legível de código. Esses requisitos podem ser alcançados através de algumas técnicas, uma das quais está escrevendo comentários de código.
Ao falar sobre comentários do código, sempre há um debate sem fim. Devemos usar comentários para ilustrar o papel do nosso código? Devemos nos concentrar na expressividade do código sem precisar de comentários para ajudar na leitura? Joe Kunk escreveu um blog sobre o argumento - você não deveria escrever comentários. Algumas pessoas dizem que o código bem documentado é considerado um bom código e alguns dizem que os comentários devem ser evitados porque os comentários são frequentemente usados para explicar/ocultar o código ruim.
Na minha opinião, sob a influência dos livros, para garantir que o código seja limpo e fácil de refatorar, devemos evitar escrever comentários, a menos que tenhamos um bom motivo para escrever comentários (como algoritmos matemáticos) ou devido aos requisitos ou processos da empresa, somos obrigados a fazê -lo. Aqui estão cinco preocupações sobre as notas.
Onde eu acho que os comentários de código funcionam contra-efeitos 1. Os comentários geralmente incentivam o código ruimO código comentado é um bom código, existe um ditado, então as pessoas geralmente adicionam comentários ao código para tornar o código bonito. Se adicionarmos comentários para interpretar o código, é como um sinal: talvez estamos escrevendo código ruim. Quando queremos escrever um comentário, devemos nos perguntar se podemos torná -lo mais legível limpando o código.
2. Vamos gastar mais tempo escrevendo e mantendoOs comentários geralmente são a segunda versão do código. Na verdade, estamos nos repetindo quando escrevemos comentários para uma função. Nós violamos o princípio seco (não se repete). Estamos gastando mais tempo e adicionando complexidade. Se os requisitos mudarem, o código também deve alterar e, se escrevermos comentários, também devemos alterá -los. Portanto, faça uma alteração pelo dobro do tempo que você gasta. Podemos usar esse tempo para melhorar nosso código ou desenvolver novos recursos.
3. Os comentários não são testáveis e verificadosQuando modificamos o código, usamos compiladores, IDEs e ferramentas de teste de unidade para ajudar, e não há comentários nem ferramentas semelhantes. Você não pode confiar em ferramentas ou testes de unidade para garantir que eles sejam usados corretamente, anotações de data, etc. Depois de escrever um comentário, porque é inestável e não pode prestar atenção à sua precisão, será preservada sem serem detectadas quando der errado.
4. Os comentários não são confiáveis em comparação com o códigoGeralmente, quando os comentários e o código saem disso, torna -se menos significativo. Se um programador lê, poderá ser enganado. Mesmo sem enganar, você precisa ler o código -fonte para descobrir o que está fazendo. Para um exemplo prático, se nosso chefe precisarmos de fazer uma modificação, devemos olhar para os comentários ou código? Claro que veremos o código.
5. Os comentários ocupam muito espaço na telaAlguns métodos de comentários (como o abaixo) ocupam muitas linhas, o que se torna um problema quando você deseja ver mais código.
/**
*
* @param título O título do CD
* @param autor o autor do CD
* @param rastreia o número de faixas no CD
* @param durationinMinutes a duração do CD em minutos
*/
public void addcd (título da string, autor da string,
INT faixas, int durationInminutes) {
CD CD = novo CD ();
cd.title = title;
CD.Author = Autor;
CD.Tracks = Tracks;
cd.Duration = Duração;
cdlist.add (CD);
}