Como os comentários são geralmente tratados em linguagens de programação e marcação? Estou escrevendo um analisador para alguma linguagem de marcação personalizada e quero seguir o princípio da menor surpresa , então estou tentando determinar a convenção geral. Por exemplo, um comentário...
Fechado . Esta questão é baseada em opiniões . No momento, não está aceitando respostas. Deseja melhorar esta pergunta? Atualize a pergunta para que ela possa ser respondida com fatos e citações editando esta postagem . Fechado há 5 anos . Vi isso...
Deseja melhorar este post? Forneça respostas detalhadas para esta pergunta, incluindo citações e uma explicação de por que sua resposta está correta. Respostas sem detalhes suficientes podem ser editadas ou excluídas. Esta pergunta foi migrada do Stack...
Esta pergunta foi migrada do Stack Overflow porque pode ser respondida no Software Engineering Stack Exchange. Migrou há 8 anos . Quero ouvir de você algum conselho e experiência em escrever comentários em seu código. Como você os escreve da maneira mais fácil e
Fechado . Esta questão é baseada em opiniões . No momento, não está aceitando respostas. Deseja melhorar esta pergunta? Atualize a pergunta para que ela possa ser respondida com fatos e citações editando esta postagem . Fechado há 4 anos . Estou apenas...
Aparece em não apenas um idioma que os comentários não podem ser aninhados. Você tem uma boa solução para este problema? Uma solução alternativa em C / C ++ e Java é usar apenas o comentário de linha única, mas torna-se impossível comentar um bloco maior. Estou enfrentando algo...
Bloqueado . Os comentários sobre esta pergunta foram desativados, mas ainda estão aceitando novas respostas e outras interações. Saiba mais . Eu fiz uma pesquisa, mas não encontrei o que estava procurando. Sinta-se à vontade para me vincular se esta pergunta já tiver...
Sempre que descubro que grande parte do meu código precisa ser alterada, seja porque está incorreta ou porque precisa ser adaptada às principais mudanças arquiteturais necessárias por outros motivos, é o que normalmente faço: Comento todo o código que suspeito que possa ter que ser alterado....
Esta pergunta foi migrada do Stack Overflow porque pode ser respondida no Software Engineering Stack Exchange. Migrou há 7 anos . Comentar hoje em dia é mais fácil do que nunca. Em Java, existem algumas boas técnicas para vincular comentários a classes, e os Java IDEs são...
Estou procurando uma recomendação de uma prática recomendada para comentários XML em C #. Quando você cria uma propriedade, parece que a documentação XML esperada possui o seguinte formato: /// <summary> /// Gets or sets the ID the uniquely identifies this <see cref="User" />...
Em alguns projetos de código aberto, reuni o seguinte estilo de codificação void someFunction(bool forget); void ourFunction() { someFunction(false /* forget */); } Eu sempre tenho dúvidas sobre o que falsesignifica aqui. Isso significa "esquecer" ou "esquecer" se refere ao parâmetro...
Fechado . Esta questão é baseada em opiniões . No momento, não está aceitando respostas. Deseja melhorar esta pergunta? Atualize a pergunta para que ela possa ser respondida com fatos e citações editando esta postagem . Fechado há 4 anos . Eu sempre vi...
Eu vi muitos números de problemas de comentários do código jQuery . (Na verdade, havia 69 números de problemas no código jQuery.) Acho que seria uma boa prática, mas nunca vi nenhuma orientação. Se for uma boa prática, quais são as diretrizes para essa
Alguns sim, mas nenhum dos populares até onde eu sei. Há algo de ruim em aninhar comentários? Pretendo que os comentários em bloco sejam aninhados no (pequeno) idioma em que estou trabalhando, mas gostaria de saber se isso é uma má
O desenvolvedor sênior em nossa loja insiste em que, sempre que o código for modificado, o programador responsável deve adicionar um comentário embutido informando o que ele fez. Esses comentários geralmente se parecem// YYYY-MM-DD <User ID> Added this IF block per bug 1234. Usamos o TFS...
Um dos desenvolvedores da minha equipe acredita que é necessário escrever um comentário javadoc para TODOS os parâmetros na assinatura de um método. Não acho que isso seja necessário e, de fato, acho que pode até ser prejudicial. Primeiro, acho que os nomes dos parâmetros devem ser descritivos e...
Em algumas bases de código, você pode ver comentários dizendo coisas como: // Workaround for defect 'xxx', (See bug 1434594 on Sun's bugparade) Então, eu tenho algumas perguntas, mas todas são relacionadas. É correto colocar um link para perguntas do SO nos comentários de um programa: //...
É uma prática recomendada jogar NotImplementedExceptioncódigo que você ainda não escreveu? Possivelmente os comentários do TODO seriam considerados mais
É difícil dizer o que está sendo pedido aqui. Essa pergunta é ambígua, vaga, incompleta, excessivamente ampla ou retórica e não pode ser razoavelmente respondida em sua forma atual. Para obter ajuda para esclarecer esta questão para que possa ser reaberta, visite o centro de ajuda...
Atualmente, essa questão não se encaixa no nosso formato de perguntas e respostas. Esperamos que as respostas sejam apoiadas por fatos, referências ou conhecimentos, mas essa pergunta provavelmente solicitará debates, argumentos, pesquisas ou discussões prolongadas. Se você acha que...