Ousterhout apresenta algumas convenções para fazer comentários, dentre essas ele recomenda que a primeira coisa que você deve fazer ao criar uma classe é escrever comentários, os quais se dividem em dois tipos: alto-nível e baixo-nível.
Comentários de alto-nível são sobre a finalidade da classe e sua relação com outras classes. Esse tipo de comentário deve resumir tudo o que alguém precisa saber sobre a classe, exceto detalhes de implementação.
Comentáros de baixo nível são aqueles espalhados pela classe, devem funcionar como uma lanterna, cuja finalidade é esclarecer o como e o porquê - desde que o código não esteja claro o suficiente para responder a isso por si só.
Abordagem interessante.
No comments:
Post a Comment