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"?
c++
coding-style
comments
code-formatting
headers
Mateen Ulhaq
fonte
fonte
Respostas:
Em relação ao estilo de formatação, a consistência é mais importante. Verifique se todos os comentários de definição de classe se parecem com todos os outros, todos os comentários de método se parecem com todos os outros, etc.
Portanto, se você estiver modificando o código existente , siga o estilo de formatação. Os comentários (e, até certo ponto, o código) devem parecer que apenas uma pessoa trabalhou no arquivo. Se você estiver iniciando um novo projeto, escolha um formato de estilo e atenha-se a ele.
Locais para começar a procurar:
fonte