Skip to main content
Post Locked by Thomas Owens
Notice added Historical significance by Thomas Owens
Post Closed as "Opinion-based" by Thomas Owens
Notice removed Reward existing answer by user280550
Bounty Ended with user1249's answer chosen by CommunityBot
Notice added Reward existing answer by user280550
Bounty Started worth 100 reputation by CommunityBot
Containing spelling corrections due to higher impact
Source Link

How would one know if the code one has created is easily readable, understandable, and maintainable? Of course from the author's point of view, the code is readable and maintainable, because the author wrote it and edited it, to begin with. However, there must be an objective and quantifiable standard by which our profession can measure code.

These goals are met when one may do the following with the code without the expert advice of the original author:

  • It is possible to read the code and understand at a basic level the flow of logic.

  • It is possible to understand at a deeper level what the code is doing to include inputs, outputs, and algorithms.

  • Other developers can make meaningful changes to the original code such as bug fixes or refactoring.

  • One can write new code such as a class or module that leverages the original code.

How do we quantify or measure code quality so that we know it it readable, understandable, and maintainable?

How would one know if the code one has created is easily readable, understandable, and maintainable? Of course from the author's point of view the code is readable and maintainable, because the author wrote it and edited it to begin with. However, there must be an objective and quantifiable standard by which our profession can measure code.

These goals are met when one may do the following with the code without the expert advice of the original author:

  • It is possible to read the code and understand at a basic level the flow of logic.

  • It is possible to understand at a deeper level what the code is doing to include inputs, outputs, and algorithms.

  • Other developers can make meaningful changes to the original code such as bug fixes or refactoring.

  • One can write new code such as a class or module that leverages the original code.

How do we quantify or measure code quality so that we know it it readable, understandable, and maintainable?

How would one know if the code one has created is easily readable, understandable, and maintainable? Of course from the author's point of view, the code is readable and maintainable, because the author wrote it and edited it, to begin with. However, there must be an objective and quantifiable standard by which our profession can measure code.

These goals are met when one may do the following with the code without the expert advice of the original author:

  • It is possible to read the code and understand at a basic level the flow of logic.

  • It is possible to understand at a deeper level what the code is doing to include inputs, outputs, and algorithms.

  • Other developers can make meaningful changes to the original code such as bug fixes or refactoring.

  • One can write new code such as a class or module that leverages the original code.

How do we quantify or measure code quality so that we know it readable, understandable, and maintainable?

Added code reviews tag
Link
SDsolar
  • 139
  • 1
  • 1
  • 10
edited tags
Link
Thomas Owens
  • 85.9k
  • 18
  • 211
  • 311
Expanded on question to make it more specific and less open-ended per the meta discussion mentioned in the comments.
Source Link
user22815
user22815
Loading
Tag nuke
Link
durron597
  • 7.6k
  • 11
  • 39
  • 67
Loading
Grammar mistakes in the question.
Source Link
Kilian Foth
  • 111k
  • 45
  • 301
  • 323
Loading
Question Protected by Doc Brown
Post Made Community Wiki by JohnFx
Notice added Needs detailed answers by ChrisF
Copy edited (code, as computer program, is an uncountable noun - ref. <http://en.wiktionary.org/wiki/code#Noun>, 7.)
Source Link
Loading
Tweeted twitter.com/#!/StackProgrammer/status/182887460206952448
spelling cleanup, tags
Source Link
gnat
  • 20.5k
  • 29
  • 117
  • 308
Loading
Source Link
KyelJmD
  • 981
  • 5
  • 10
  • 20
Loading