Por que todo mundo escreve comentários de afazeres em letras maiúsculas? [fechadas]
9
Estou fazendo o mesmo Quando há algo "pendente" no meu código, escrevo //TODO .... Mas estou curioso para saber quando isso começou e se há uma razão para escrever "tarefas" em todas as letras maiúsculas?
Porque nós realmente SIGNIFICAMOS (nós nunca chegamos a um ponto)
Anthony Pegram
3
assim os editores podem marcá-los e deixá-lo procurar por eles (lista de tarefas do eclipse por exemplo)
aberração catraca
6
Como você não pode realmente colocar o texto em negrito no código, você precisa de uma maneira de destacar coisas importantes. Portanto ...
Karlson
4
Por que isso Importa?
Rook
3
I write//todo:...
BЈовић
Respostas:
23
Além disso, é ótimo ter uma maneira de pesquisar facilmente as seções de código que você encobriu e deseja retornar. Você pode fazer uma pesquisa que diferencia maiúsculas de minúsculas de "TODO" para encontrar imediatamente o que você pulou antes.
"todo" (letras minúsculas) pode fazer parte de uma palavra / função / variável maior, mas provavelmente "TODO" (letras maiúsculas) provavelmente não será.
Também permite aos editores destacar isso. O gedit faz isso, por exemplo, e somente para todas as letras maiúsculas TODO. Seja qual for o motivo, é suficiente incentivo para escrevê-lo em maiúsculas.
4
@ delnan: Essa é uma tautologia. Foi feito para se destacar, então as pessoas o usavam, então alguém adicionou a sintaxe destacada no vim para se destacar mais, para que as pessoas o usassem para se destacar. As pessoas não o usam porque o editor destaca; elas o usam porque é comum fazê-lo e, portanto, o editor o destaca. Você pode destacar qualquer coisa no vim. Apenas altere a sintaxe, destacando adequadamente. É tão fácil tododestacar, mas há pouco sentido nisso, pois a convenção é usar o TODO.
Martin York
11
@LokiAstari: Como eu disse, eu o soletro em maiúsculas porque mais editores destacam isso por padrão. Mas talvez eu seja uma exceção: muito jovem (então eu não poderia ter feito isso antes dos editores o apoiarem) e (infelizmente) muito covarde e preguiçoso para ajustar manualmente o realce da sintaxe.
Também é bom para o pobre rapaz que precisa limpar depois de você e para quem precisa examinar seu código antes que ele seja concluído. Eles podem ver rapidamente o que ainda não foi feito por causa dessa convenção.
sq33G
2
Encontrei TODO com maiúsculas e minúsculas em um nome de variável como filesToDownload. Obviamente, a pesquisa "somente palavras inteiras" corrige esse problema.
dan04
8
Estou curioso para saber quando isso começou e se há uma razão para escrever sobre o que fazer em dinheiro?
A idéia com comentários como TODO e FIXME é fazê-los sobressair. Geralmente, você não deseja enviar o código que possui esses marcadores no código - eles marcam as coisas a serem feitas antes que o projeto possa ser considerado completo. O uso do ALL CAPS os torna um pouco mais fáceis de detectar, desde que você não use o ALL CAPS para muitas outras coisas no seu código.
O Visual Studio começou a fazer os comentários // TODO: quando adicionou pela primeira vez os geradores de código para as coisas padrão do MFC. Essa foi a versão 2.0, iirc.
Mjfgates
pelo menos para o Visual studio, essa pesquisa não diferencia maiúsculas de minúsculas - ela também puxará // todo foo para a lista de tarefas
jk.
4
Apenas me destaca e é fácil de pegar ... nada complicado!
que e é fácil de encontrar através grep ou similar
Zachary K
@ZacharyK: Exatamente!
Dynamic
1
Chama a atenção o fato de que existe um todo.
É importante que seja óbvio o tempo todo que alguém precise voltar ao código. As informações precisam ser conhecidas apenas pela pessoa que voltar para resolver o problema.
Outros editores têm recursos de pesquisa e você pode pesquisar facilmente por todas as tarefas .
precisa
Exceto que 'todo' pode aparecer em algo mais como um nome de variável ou outro texto de comentário ... #
707
11
vi faz distinção entre maiúsculas e minúsculas. Como os caps são usados com moderação na maioria dos idiomas modernos (em coisas como constantes nomeadas), a pesquisa tem uma alta probabilidade de sucesso.
Ncmathsadist
1
Alguns editores destacam apenas os itens TODO em maiúsculas, portanto, é mais seguro usar sempre em maiúsculas.
Visualmente, o ALL CAPS se destaca, mas não é muito legível. Ao ler o código, eles digitalizam como um bloco de um tamanho específico. Realmente não importa quais são as letras. Eles apenas se destacam e podem ser vistos muito rapidamente. Depois de trabalhar com as tags há algum tempo, seu cérebro reconhecerá a palavra pela forma.
Do ponto de vista das ferramentas (IDE / Editor), a pesquisa com distinção entre maiúsculas e minúsculas terá uma taxa de falsos positivos muito baixa em todas as versões de caps. Em alguns estilos de codificação, existe um pequeno risco de que uma constante seja correspondida. A pesquisa de palavras inteiras com distinção entre maiúsculas e minúsculas torna os falsos positivos ainda menos prováveis.
Uma vez que a ferramenta a coloca na tela, o formato diz claramente veja AQUI. Quando você estiver focado no local, a parte legível será o comentário relacionado.
//todo:...Respostas:
Além disso, é ótimo ter uma maneira de pesquisar facilmente as seções de código que você encobriu e deseja retornar. Você pode fazer uma pesquisa que diferencia maiúsculas de minúsculas de "TODO" para encontrar imediatamente o que você pulou antes.
"todo" (letras minúsculas) pode fazer parte de uma palavra / função / variável maior, mas provavelmente "TODO" (letras maiúsculas) provavelmente não será.
fonte
TODO. Seja qual for o motivo, é suficiente incentivo para escrevê-lo em maiúsculas.tododestacar, mas há pouco sentido nisso, pois a convenção é usar o TODO.filesToDownload. Obviamente, a pesquisa "somente palavras inteiras" corrige esse problema.A idéia com comentários como TODO e FIXME é fazê-los sobressair. Geralmente, você não deseja enviar o código que possui esses marcadores no código - eles marcam as coisas a serem feitas antes que o projeto possa ser considerado completo. O uso do ALL CAPS os torna um pouco mais fáceis de detectar, desde que você não use o ALL CAPS para muitas outras coisas no seu código.
fonte
O Eclipse e o Visual Studio têm recursos da Lista de tarefas que fornecem automaticamente listas de linhas de comentários que contêm TODO.
fonte
Apenas me destaca e é fácil de pegar ... nada complicado!
fonte
Chama a atenção o fato de que existe um todo.
É importante que seja óbvio o tempo todo que alguém precise voltar ao código. As informações precisam ser conhecidas apenas pela pessoa que voltar para resolver o problema.
fonte
Se você é um usuário vi, use:
Você chegará lá muito rápido.
fonte
Alguns editores destacam apenas os itens TODO em maiúsculas, portanto, é mais seguro usar sempre em maiúsculas.
fonte
Visualmente, o ALL CAPS se destaca, mas não é muito legível. Ao ler o código, eles digitalizam como um bloco de um tamanho específico. Realmente não importa quais são as letras. Eles apenas se destacam e podem ser vistos muito rapidamente. Depois de trabalhar com as tags há algum tempo, seu cérebro reconhecerá a palavra pela forma.
Do ponto de vista das ferramentas (IDE / Editor), a pesquisa com distinção entre maiúsculas e minúsculas terá uma taxa de falsos positivos muito baixa em todas as versões de caps. Em alguns estilos de codificação, existe um pequeno risco de que uma constante seja correspondida. A pesquisa de palavras inteiras com distinção entre maiúsculas e minúsculas torna os falsos positivos ainda menos prováveis.
Uma vez que a ferramenta a coloca na tela, o formato diz claramente veja AQUI. Quando você estiver focado no local, a parte legível será o comentário relacionado.
fonte