comments close to code for transactional update
·
The best way to ensure that comments get updated is to position them close to the code they describe, so developers will see them when they change the code. The farther a comment is from its associated code, the less likely it is that it will be updated properly. For example, the best place for a method’s interface comment is in the code file, right next to the body of the method. Any changes to the method will involve this code, so the developer is likely to see the interface comments and update them if needed.
Обратные ссылки
A Philosophy of Software Design
Книга посвящена созданию хорошего дизайна при разработке программного обеспечения. В основе лежит два списка правил:...