#codeasdocumentation search results
i confess.. i am a proud self documenting code fiend ... and i just reread this M. Fowler article. gold #meaningfulnames #intentionRevealingNames #codeAsDocumentation
Agreed, I do see a hesitation to use latest tools and techniques like swagger, #codeasdocumentation, Design diagrams, established patterns ..
But I agree with @martinfowler: Code should be readable as good documentation. bit.ly/1N7P0Iy #codeAsDocumentation
I don't agree with #codeAsDocumentation because code is not readable by business.
Good documentation tells what a system is suppoded to do Good code tells what a system actually does You need both #codeAsDocumentation
It's faster to use a widget that is part of the #designsystem than to take a 'shortcut' and build something new. #EUX16 #codeasdocumentation
"We as a whole industry need to put much more emphasis on valuing the clarity of code." - M. Fowler #selfDocumentingCode #codeAsDocumentation
So the server implementation of the specifications above is here : github.com/wardle/go-term… A makefile generates the server and client stub code from the specifications. #codeAsDocumentation
github.com
GitHub - wardle/go-terminology: A SNOMED terminology server and command line tool.
A SNOMED terminology server and command line tool. - wardle/go-terminology
Mystery solved! #CodeAsDocumentation lol Guess kung sinong mag a-ala detective conan bukas sa standup meeting namin HAHAH
Documents are necessary for larger teams but their usefulness for the sake of properly domain modeled code is limited They get outdated quick fast #intentionRevealingInterface #codeAsDocumentation
Every time you write documentation in a cooking recipe way, you are one step closer to scripting and automation #CodeAsDocumentation
one of my favorite topics - the naming of things naming things is hard but oh so worth it 💫 #selfDocumentingCode #codeAsDocumentation #ubiquitousLanguage #meaningfulNames
then i later come back during refactoring and try to clarify the design/code; so i end up not needing those comments either; the comments left are for javadoc (and javadoc doesnt count as comments) #selfDocumentingCode #codeAsDocumentation
The code don't lie. But in tandem with conversations in ubiquitous language can tell a more complete truth about the software #codeAsDocumentation #IRI #intentionRevealingInterfaces #ubiquitousLanguage
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
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)?
keep this in mind next time you sit down to write tests, whether "test first" or tests written after the fact. fr this puts some respec on tdd/testing. #codeAsDocumentation #tddAsDocumentation #testsAsDocumentation
The best documenation for your system is your tests. And a lot of that "how to" documentation is TDD & acceptance tests. Systems built w/ TDD need very little documenation. The so-called "tests" are actually a nice set of examples of how to use the system. What's left is "why?"
Mystery solved! #CodeAsDocumentation lol Guess kung sinong mag a-ala detective conan bukas sa standup meeting namin HAHAH
Agreed, I do see a hesitation to use latest tools and techniques like swagger, #codeasdocumentation, Design diagrams, established patterns ..
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
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)?
keep this in mind next time you sit down to write tests, whether "test first" or tests written after the fact. fr this puts some respec on tdd/testing. #codeAsDocumentation #tddAsDocumentation #testsAsDocumentation
The best documenation for your system is your tests. And a lot of that "how to" documentation is TDD & acceptance tests. Systems built w/ TDD need very little documenation. The so-called "tests" are actually a nice set of examples of how to use the system. What's left is "why?"
then i later come back during refactoring and try to clarify the design/code; so i end up not needing those comments either; the comments left are for javadoc (and javadoc doesnt count as comments) #selfDocumentingCode #codeAsDocumentation
one of my favorite topics - the naming of things naming things is hard but oh so worth it 💫 #selfDocumentingCode #codeAsDocumentation #ubiquitousLanguage #meaningfulNames
"We as a whole industry need to put much more emphasis on valuing the clarity of code." - M. Fowler #selfDocumentingCode #codeAsDocumentation
i confess.. i am a proud self documenting code fiend ... and i just reread this M. Fowler article. gold #meaningfulnames #intentionRevealingNames #codeAsDocumentation
The code don't lie. But in tandem with conversations in ubiquitous language can tell a more complete truth about the software #codeAsDocumentation #IRI #intentionRevealingInterfaces #ubiquitousLanguage
Documents are necessary for larger teams but their usefulness for the sake of properly domain modeled code is limited They get outdated quick fast #intentionRevealingInterface #codeAsDocumentation
So the server implementation of the specifications above is here : github.com/wardle/go-term… A makefile generates the server and client stub code from the specifications. #codeAsDocumentation
github.com
GitHub - wardle/go-terminology: A SNOMED terminology server and command line tool.
A SNOMED terminology server and command line tool. - wardle/go-terminology
It's faster to use a widget that is part of the #designsystem than to take a 'shortcut' and build something new. #EUX16 #codeasdocumentation
Good documentation tells what a system is suppoded to do Good code tells what a system actually does You need both #codeAsDocumentation
But I agree with @martinfowler: Code should be readable as good documentation. bit.ly/1N7P0Iy #codeAsDocumentation
I don't agree with #codeAsDocumentation because code is not readable by business.
Every time you write documentation in a cooking recipe way, you are one step closer to scripting and automation #CodeAsDocumentation
i confess.. i am a proud self documenting code fiend ... and i just reread this M. Fowler article. gold #meaningfulnames #intentionRevealingNames #codeAsDocumentation
Something went wrong.
Something went wrong.
United States Trends
- 1. Grammy 435K posts
- 2. #FliffCashFriday 2,479 posts
- 3. Dizzy 11.2K posts
- 4. Vesia 2,717 posts
- 5. #drwfirstgoal N/A
- 6. James Watson 11.7K posts
- 7. Georgetown 2,240 posts
- 8. Myles Rice N/A
- 9. Capitol Police 15.1K posts
- 10. Dylan Edwards N/A
- 11. Chase 88.4K posts
- 12. MANELYK EN COMPLICES 16.7K posts
- 13. Collar 14.6K posts
- 14. Clipse 24.9K posts
- 15. Thank a Republican N/A
- 16. Darryl Strawberry 1,744 posts
- 17. Kendrick 68.6K posts
- 18. Filibuster 385K posts
- 19. Jeremy Renner 4,980 posts
- 20. NBA Cup 5,322 posts