#codeasdocumentation - Twitter Hashtag

almost 6 years ago

i do find the comments at the top of a class heading, that state the singular purpose of the class, to be useful; outside of that im generally anti-comment #codeAsDocumentation #selfDocumentingCode #singleResponsibilityPrinciple

Mario Cervera @macerub

almost 6 years ago

I tend to avoid comments. I prefer self-explanatory code. But some types of comments can indeed be helpful. For example, if I wrote some code in a convoluted way for performance reasons, I'd document these reasons in a comment. ❓ What comments do you find useful (or useless)?

24

56

6

2

0

2

0

rasiim.md

@refactorfiend

almost 6 years ago

one of my favorite topics - the naming of things naming things is hard but oh so worth it 💫 #selfDocumentingCode #codeAsDocumentation #ubiquitousLanguage #meaningfulNames

1

2

0

rasiim.md

@refactorfiend

about 6 years ago

"We as a whole industry need to put much more emphasis on valuing the clarity of code." - M. Fowler #selfDocumentingCode #codeAsDocumentation

0

Mark Wardle @mwardle

over 7 years ago

@marcus_baw @MattStibbs @INTEROPenAPI So the server implementation of the specifications above is here : https://t.co/UM4Yl4JsYg A makefile generates the server and client stub code from the specifications. #codeAsDocumentation

0

1

0