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...
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...
<body> <!-- wrapper --> <div id="wrapper"> <!-- title --> <div id="title"><img src="title.png" alt="" /></div> <!-- form wrapper --> <div id="form_wrapper"> <!-- form --> <form action="thankyou.php" method="POST">...
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...
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...
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...
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...
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...
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...