Perguntas com a marcação «comments»

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" /> instance. /// </summary> public int ID …

19 c#  .net  programming-practices  comments 

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 prática?

18 comments  issue-tracking 

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á ideia.

18 language-agnostic  syntax  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 . Eu sempre vi esses comentários serem usados: function foo() …

18 source-code  comments 

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 para controle de revisão, …

17 coding-standards  comments 

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 auto-documentados. …

17 java  documentation  source-code  comments  maintainability 

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: // We're now mapping …

16 comments 

É uma prática recomendada jogar NotImplementedExceptioncódigo que você ainda não escreveu? Possivelmente os comentários do TODO seriam considerados mais seguros?

15 .net  comments  coding  exceptions 

É 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 . Fechado há 8 …

15 comments 

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 essa pergunta pode ser melhorada e possivelmente reaberta, visite o centro …

15 comments 

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 a nossa filial e, em alguns casos, os deixou …

14 version-control  comments  coding-style 

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 alguma forma eu …

14 productivity  code-reviews  comments  workflows  image-manipulation 

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, …

13 java  c#  programming-practices  code-quality  comments 

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 Namespace> /// Class: <Class Name> /// Description: <Description> /// Author: <Author> Date: <DateTime> /// Notes: <Notes> /// Revision …

13 c#  documentation  comments 

É 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 compilador otimize essa linha adicionalmente. Mas isso é considerado um …

12 coding-style  comments