No Delphi, existe duas maneira de comentar. Comentários em bloco e linhas de comentários, comentário de linhas utilizamos o símbolo "//" desta maneira o compilador ignora toda a linha a partir de onde se encontra o símbolo.
var i, j: integer
...
i: = 0; / / j: = 5
...
// Showmensage("Ola Mundo");
Porém a minha intenção não é dizer as formas que o Delphi tem de comentar um código. Os comentários e para compensar o nosso fracasso em expressar no código, além disso muitas das vezes os comentários acabam ficando obsoletos e acaba mentindo a sua intenção para que foi criada, sem contar o trabalho que aumenta nas manutenção no dia a dia de desenvolvimento.
Os comentários são utilizados de maneira geral para compensar um código confuso ou desorganizado, ao invés de usar um comentário explique-se no código.
//Verifica se o funcionário tem direito a todos os benefícios
if ((empregado.flags in [Horly_flag]) or (empregado.idade >65)) then
podemos refactorar para um código mais elegante
//Verifica se o funcionário tem direito a todos os benefícios
if empregado.temtodosbeneficios then
Podemos classificar os comentários como informativos, esclarecimentos, legais, alerta, TODO. Os comentários informativos podem ser práticos na maioria das vezes, porém sempre que possível é melhor usar o nome da função para transmitir a informação. Há casos que temos de informar por exemplo quando temos uma expressão regular é um bom lugar para colocar um comentário informativo.
//Formato igual a HH:MM:SS
AValor := regex.parser("\\d*:\\d*:\\d*");
begin
// TODO -oMarcelo Fernandes -cTesteUnitario: Setup method call parameters
// TODO: Validate method results
end;
Existes alguns tipos de comentários que devemos evitar, como os comentários redundantes, enganadores, longos, de posição e o próprio código comentado, mas para isso vou deixar você leitor dar uma espiada no capítulo 4 do livro código limpo como evitar estes tipos de comentários.
