Considere marcadores de conflito. ou seja: <<<<<<< branch blah blah this ======= blah blah that >>>>>>> HEAD No caso específico que me motivou a postar essa pergunta, o membro da equipe responsável havia acabado de concluir uma mesclagem do montante para...
Eu escrevo muito código (principalmente c ++ e javascript) que aborda geometria computacional e gráficos e esses tipos de tópicos, então descobri que os diagramas visuais têm sido uma parte indispensável do processo de solução de problemas. Eu determinei agora que "oh, não seria fantástico se de...
Estamos refatorando uma base de código herdada de 20 anos e estou tendo uma discussão com meu colega sobre o formato dos comentários no código (plsql, java). Não há um formato padrão para comentários, mas na maioria dos casos as pessoas fazem algo assim no comentário: // date (year, year-month,...
Estou procurando um formato informativo de documentação de classe para minhas classes de Entidade, Lógica de negócios e Acesso a dados. Encontrei seguindo dois formatos daqui Formato 1 ///----------------------------------------------------------------- /// Namespace: <Class...
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. A maioria dos...
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...
É bom estilo usar variáveis locais tecnicamente supérfluas adicionais para descrever o que está acontecendo? Por exemplo: bool easyUnderstandableIsTrue = (/* rather cryptic boolean expessions */); if(easyUnderstandableIsTrue) { // ... } Quando se trata de sobrecarga técnica, espero que o...
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
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
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...
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...
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...
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...
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
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...
É 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 }...
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...
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 isso e...
Esta pode ser uma pergunta estúpida, mas está na minha cabeça há um tempo e não consigo encontrar uma resposta decente em nenhum outro lugar. Eu tenho um professor que diz que devemos listar explicitamente cada parâmetro com uma descrição, mesmo se houver apenas um. Isso leva a muita...
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