sansguidon/bookmarks
1
0
Fork 0
Code Issues 16 Pull Requests 1 Packages Projects 1 Releases Activity

clean code naming tips

Browse Source
This commit is contained in:
Morgan 2017-11-06 11:25:21 +01:00 committed by GitHub
parent 64cab43ceb
commit ef56ca7b2e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
PRINCIPLES.md
View File

@ -72,7 +72,10 @@
* Boolean names should always answer yes/no * Boolean names should always answer yes/no
* Classes are nouns. Avoid meaningless names (OrderInfo, OrderData vs Order) * Classes are nouns. Avoid meaningless names (OrderInfo, OrderData vs Order)
* Delete the interfaces : except for Remoting/API client jars and strategy pattern implementation. * Delete the interfaces : except for Remoting/API client jars and strategy pattern implementation.
* Make the name speak for itself * Names : Make the name speak for itself. Apply Continuous renaming as your learn the application
* Names : Names should be at least pronounceable. Don't abbreviate ! Unless it's a basic business concept, like VAT
* Names : should be consistent and unique (synonyms confuse).
* Names should have meaningful context. eg: order.customerFirstName. But don't repeat yourself (DRY) : Order.~~order~~CreationDate
## personal thoughts ## personal thoughts
* [MorganGeek](https://twitter.com/MorganGeek/statuses/420907517934178304) - Problem solving / Productivity : Good programmers write code after they found the solution. Un bon programmeur ne commence à coder qu'après avoir trouvé une solution. * [MorganGeek](https://twitter.com/MorganGeek/statuses/420907517934178304) - Problem solving / Productivity : Good programmers write code after they found the solution. Un bon programmeur ne commence à coder qu'après avoir trouvé une solution.