#selfDocumentingCode - Twitter Hashtag

over 4 years ago

If you need to use one or more temp variables to reduce the complexity of an "if" statement, then use one or more temp variables. Your colleagues and your future self will thank you. #SelfDocumentingCode

0

5

0

1

0

Nicola Costantino @costantino_dev

over 5 years ago

@aarondfrancis A description is always very helpful for the reviewer(s), but here it looks like you understood each other without even having to say a word 👍🏻 - the power of the #selfdocumentingcode

1

5

0

rasiim.md @refactorfiend

over 5 years ago

refactoring to good naming is supm anyone can practice regardless of experience level #descriptiveAndMeaningfulPhrases #descriptiveAndMeaningfulNames #damp #damn #intentionRevealingNames #namingConventions #selfDocumentingCode #CodeNewbie

0

2

1

0

rasiim.md @refactorfiend

about 6 years ago

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

2

6

0

2

0

rasiim.md @refactorfiend

about 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

about 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

over 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

over 6 years ago

when good devs hear off-hand, disparaging remarks about "naming" vars, classes etc, e.g: "name it whatever" "who cares what you call it" "same difference" #intentionRevealingInterfaces #intentionRevealingNames #selfDocumentingCode #descriptiveAndMeaningfulPhrases #ddDeveloper

0

1

0

rasiim.md @refactorfiend

over 6 years ago

err on the side of conceptual clarity over technical cleverness.. the concepts in the story your design/code tells about the domain solution, is more important than "teh tech" #ddDesign #modularCode #selfDocumentingCode #coders

1

3

0

rasiim.md @refactorfiend

over 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

helmstetter @helmstetter

over 7 years ago

Best function name ever: distributedTransaction_TaylorSwiftStartsFollowingLorde() MongoDB Distributed transactions in a sharded cluster #MDBW19 #selfdocumentingcode