Navigation Menu

Skip to content

Instantly share code, notes, and snippets.

@eridal
Created August 20, 2014 18:00
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save eridal/6aa90bd331b1f625056a to your computer and use it in GitHub Desktop.
Save eridal/6aa90bd331b1f625056a to your computer and use it in GitHub Desktop.
Code Zen
  • In the world of open-source development where most of the code is shared, code clarity and readability is important.
  • Object-oriented code architecture allows for much higher clarity and readability than procedural one, especially in complex code.
  • Clean and eloquent code is easier to review and independently reviewed code is more reliable and secure.
  • Code clarity largely influences the code's reusability for other purposes and by other people.
  • Consistency in a coding standard allows for cleaner and more comprehensible documentation.
  • Although it requires some tedious work, the usage of semantic checks on a massive scale pays off with more reliable code.
  • Adapting some of the familiar conventions that are used for method naming, parameter ordering, and method behavior from othe languages is better than making up new ones.
  • Unvarying return types with a fixed type for every method is better than varying return types when a value of one type can be mistaken for a value of another type.
  • Underscores in naming are simply depressing -- let's have less of those.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment