Perguntas com a marcação «comments»

Perguntas sobre como escrever comentários no código.

Estilos de documentação de comentários / no código

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 repetição: …

9 documentation comments coding-style

É geralmente útil incluir problemas do JIRA nos comentários do código?

De vez em quando, deixo comentários como # We only need to use the following for V4 of the computation. # See APIPROJ-14 for details. ou # We only need to use the following for V4 of the computation. # See https://theboringcompany.atlassian.net/browse/DIGIT-827 for details. Minha principal preocupação ao fazer isso …

8 project-management coding-style communication comments jira

A leitura do javadoc é preferível à leitura do código-fonte para se familiarizar com uma biblioteca?

Acabei de encontrar o seguinte em um manual de laboratório na universidade: Você precisa estudar as interfaces das classes gerando o javadoc para elas para saber quais operações são fornecidas (fique à vontade para olhar o código, mas ao usar o código de outra pessoa, como aqui, você deve trabalhar …

8 source-code comments javadocs

Por que algumas bibliotecas opensouce não têm comentários?

Não sei se isso acontece com a maioria das bibliotecas de código-fonte aberto, mas muitas delas eu conheço e uso (por exemplo, OpenSSL, Webkit, ...) todas elas não têm comentários ou contêm muito poucos comentários. Sem mencionar seus poucos documentos, é difícil ler o código fonte. Mal podemos entender o …

8 open-source libraries comments document

A sintaxe para desativar o código é diferente da dos comentários normais?

Por várias razões durante o desenvolvimento, às vezes comento código. Como sou caótico e às vezes com pressa, alguns deles chegam ao controle de origem. Também uso comentários para esclarecer blocos de código. Por exemplo: MyClass MyFunction() { (...) // return null; // TODO: dummy for now return obj; } …

8 comments syntax

<! - open -> Por que tantos desenvolvedores fazem isso em HTML? <! - / fechar ->

<body>  <div id="wrapper">  <div id="title"><img src="title.png" alt="" /></div>  <div id="form_wrapper">  <form action="thankyou.php" method="POST">  </form>  </div>  </div>  </body> Quase consigo entender o <!-- /wrapper …

8 comments html

Como os comentários são expressos nas gramáticas da linguagem de programação?

Estou aprendendo a criar analisadores usando gramáticas, mas fiquei preso tentando expressar comentários, porque eles podem aparecer em quase qualquer lugar. Isso indica que os comentários podem ser removidos do fluxo de token antes da análise. Essa é a prática padrão ou os comentários são sempre / frequentemente especificados em …

8 comments parsing grammar

O estilo dos comentários afeta a maneira como os leitores entendem o código?

Esta pergunta está me obcecando nos últimos 2 meses. Há algum tempo, um amigo que é um grande programador me deu alguns exemplos de códigos e, pela primeira vez, notei um estilo único de organização de comentários. Ele se esforçou para criar comentários de uma maneira que me deixasse mais …

8 comments

O que devo colocar nos comentários ao me comprometer com o Controle de Origem?

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. Sou um desenvolvedor independente e mantenho um servidor SVN para controle de origem. Até agora, não segui nada específico …

8 version-control comments

Ao utilizar nosso site, você reconhece que leu e compreendeu nossa Política de Cookies e nossa Política de Privacidade.

Licensed under cc by-sa 3.0 with attribution required.