Um bom estilo de codificação pode nos ajudar a ter ideias claras ao criar páginas da web, e os comentários do código também possuem alguns pequenos conhecimentos.
Resumi os padrões de anotação que utilizei no meu trabalho. Na verdade, não há conteúdo técnico. O principal é ficar atento aos padrões, o que facilita o método de produção unificado e facilita a manutenção.
Essas experiências incluem quatro partes: "Comentários da região", "Comentários de linha única", "Níveis de comentários" e "Comentários assistidos". O método de anotação de área usado pela maioria dos amigos começará com "conteúdo da anotação" ou "fim do conteúdo da anotação", "início" ou "fim", etc. Em comparação, começar com "S" ou "E" pode ser mais rápido. use, por exemplo, basta escrever o comentário inicial ou final uma vez, depois copiá-lo e alterar o "S" ou "E" para completar rapidamente o comentário na área.
No trabalho real, às vezes não está claro se a anotação deve estar acima ou abaixo do rótulo. Para evitar esta situação, as informações da anotação são escritas uniformemente antes e depois do início e do final do rótulo da região e são precedidas por "S. " ou
"
E" começa, indicando o início ou fim da anotação da área.Exemplo:
<!--=S conteúdo do comentário-->
<div>
...
</div>
<!--=E Conteúdo do comentário-->
/*=S Conteúdo do comentário*/
.aula{
...
}
.aula{
...
}
/*=E Conteúdo do comentário*/
comentário de linha única
devem ser escritas na área de conteúdo que precisa ser comentada.
Exemplo:
<div>.
<!--Conteúdo do comentário-->
...
</div>
.class{
/*Conteúdo do comentário*/
...
}
Nível de anotação
Na produção de módulos, podem existir áreas dentro de áreas. Para melhor distinguir os níveis entre áreas, é introduzido o conceito de nível de anotação. O sinal de igual na frente do comentário da área indica o nível do comentário atual.
Exemplo:
<!--=S comment content-->.
...
<!--==S Conteúdo do comentário-->
...
<!--===S Conteúdo do comentário-->
...
<!--===E Conteúdo do comentário-->
...
<!--==E Conteúdo do comentário-->
...
<!--=E Conteúdo do comentário-->
/*=S Conteúdo do comentário*/
...
/*==S Conteúdo do comentário*/
...
/*===S conteúdo do comentário*/
...
/*===E Conteúdo do comentário*/
...
/*==E Conteúdo do comentário*/
...
/*=E Conteúdo do comentário*/
Auxiliar no comentário de
informações de identificação, como hora da modificação e modificador adicionado quando mantido por não-autores. Adicione o modificador e a hora da modificação e outras informações com base no comentário de área ou comentário de linha única.
Exemplo (comentário de região):
<!--==Conteúdo do comentário S [modificador e hora da modificação]-->
<div>
...
</div>
<!--==E Conteúdo do comentário [modificador e hora da modificação]-->
/*=S Conteúdo do comentário [modificador e hora da modificação]*/
.aula{
...
}
.aula{
...
}
/*=E Conteúdo do comentário [modificador e hora da modificação]*/
Exemplo (comentário de linha única):
<div>
<!-- Conteúdo do comentário [modificador e hora da modificação]-->
...
</div>
.class{
/*Conteúdo do comentário [modificador e hora da modificação]*/
...
}