Perguntas com a marcação «comments»

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 . Para comentários sobre controle de versão, o que outros …

12 comments  source-code 

Eu tenho uma base de código privada bastante grande que evoluiu por cerca de dez anos. Não estou usando o phpDocumentor, mas como o uso das seções docblock se tornou o padrão em projetos de código aberto, adotei a escrita de docblocks para todos os métodos públicos no meu repositório. …

12 php  comments 

Estou trabalhando em um projeto "código-espaguete" e, enquanto corrigo bugs e implemento novos recursos, também faço refatoração para tornar o código testável por unidade. O código geralmente é tão fortemente acoplado ou complicado que a correção de um pequeno bug resultaria na reescrita de muitas classes. Então, decidi desenhar uma …

11 refactoring  comments 

Existem práticas comuns para comentar as expressões regulares: comentários embutidos que referem parte diferente do RegEx ou comentário geral para todas as expressões?

11 documentation  coding-style  comments 

Eu estava conversando com um colega hoje. Trabalhamos no código para dois projetos diferentes. No meu caso, sou a única pessoa trabalhando no meu código; no caso dela, várias pessoas trabalham na mesma base de código, incluindo estudantes cooperativos que entram e saem com bastante regularidade (entre a cada 8 …

11 coding-style  team  comments 

Gostaria de saber a melhor maneira de adicionar um comentário para identificar uma classe reprovada em Java. Devo remover o comentário anterior adicionado à parte superior da classe que ajuda outro programador a saber para que serve essa classe ou devo adicioná-lo abaixo do comentário?

11 java  code-quality  api  comments 

Quando escrevo pequenos scripts para mim, empilhar meu código com comentários (às vezes comento mais do que codifico). Muitas pessoas com quem falo dizem que devo documentar esses scripts, mesmo que sejam pessoais, para que, se eu os vender, eu estaria pronto. Mas os comentários não são uma forma de …

11 documentation  comments 

Eu costumava gostar de exigir comentários XML para documentação. Desde então, mudei de idéia por dois motivos principais: Como um bom código, os métodos devem ser auto-explicativos. Na prática, a maioria dos comentários XML são ruídos inúteis que não fornecem valor adicional. Muitas vezes, simplesmente usamos o GhostDoc para gerar …

10 .net  programming-practices  development-process  documentation  comments 

Sou um defensor do código devidamente documentado e estou ciente das possíveis desvantagens dele . Isso está fora do escopo desta questão. Eu gosto de seguir a regra de adicionar comentários XML para cada membro público, considerando o quanto eu gosto do IntelliSense no Visual Studio. Existe uma forma de …

10 documentation  comments  intellisense 

É uma boa prática escrever comentários para métodos amplamente conhecidos como iguais, compareTo etc? Considere o código abaixo. /** * This method compares the equality of the current object with the object of same type */ @Override public boolean equals(Object obj) { //code for equals } Minha empresa deseja inserir …

10 java  comments 

Sei que o formato "comentário do cabeçalho" varia de programador para programador, mas o que seria um exemplo de um comentário de cabeçalho "bom"?

10 c++  coding-style  comments  code-formatting  headers 

Estou lendo o Código Limpo, de Robert C. Martin, e a frase TILTinexplicavelmente aparece em alguns exemplos de código. Exemplo (a propósito, é em Java): ... public String errorMessage() { switch (status) { case ErrorCode.OK: // TILT - Should not get here. return ""; case ErrorCode.UNEXPECTED_ARGUMENT: return "Unexpected argument"; case …

9 java  clean-code  comments  conventions 

Estou prestes a sair de um projeto e, antes de partir, meu chefe me pediu para documentar o código (não o documentei muito bem). Não é grande coisa, o projeto não é terrivelmente complexo. Mas estou encontrando lugares em minha documentação onde gostaria de dizer: "Observe na linha XYZ que …

9 documentation  comments 

Eu quero escrever Javadoc de maneira SECA. Mas o documento da Oracle sobre Javadoc diz que escreva a mesma coisa novamente no comentário do método de sobrecarga. Não posso evitar a repetição?

9 documentation  comments  dry  javadocs 

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á debate, argumentos, pesquisas ou discussão prolongada. Se você acha que essa pergunta pode ser melhorada e possivelmente reaberta, visite o centro …

9 comments