re: adding code comments with respect to the single responsibility principle
As a #selfDocumentingCode fanatic, I do appreciate that some kinds of comments go a long way:
1/3
As a #selfDocumentingCode fanatic, I do appreciate that some kinds of comments go a long way:
1/3
One comment/ blurb (1-3 lines):
- at the top of a class about the single responsibility of the class
- in the project readme/wiki about the single responsibility of the application
2/3
- at the top of a class about the single responsibility of the class
- in the project readme/wiki about the single responsibility of the application
2/3
Some benefits:
- helps keep the class/application at the appropriate size
- helps make the class/application be easier to understand/work-with
3/3
- helps keep the class/application at the appropriate size
- helps make the class/application be easier to understand/work-with
3/3
#singleResponsibilityPrinciple #solidGrasp #selfDocumentingCode #internalSoftwareQuality #developerExperience #DX #developerInterfaceExperience #DIX
• • •
Missing some Tweet in this thread? You can try to
force a refresh
