OpenStax CNX

Sections
You are here: Home » Content » Documentation and Making Source Code Readable

About: Documentation and Making Source Code Readable

Module by: Kenneth Leroy Busbee. E-mail the author

View the content: Documentation and Making Source Code Readable

Metadata

Name: Documentation and Making Source Code Readable
ID: m18912
Language: English (en)
Summary: A source code listing and discussion of several items that make source code easier to read and maintain.
Subject: Science and Technology
Keywords: program documentation, source code
License: Creative Commons Attribution License CC-BY 2.0

Authors: Kenneth Leroy Busbee (ken.busbee@hccs.edu)
Copyright Holders: Kenneth Leroy Busbee (ken.busbee@hccs.edu)
Maintainers: Kenneth Leroy Busbee (ken.busbee@hccs.edu)

Latest version: 1.5 (history)
First publication date: Dec 13, 2008 9:22 am +0000
Last revision to module: Mar 16, 2010 11:30 am +0000

Downloads

PDF: m18912_1.5.pdf PDF file, for viewing content offline and printing. Learn more.
XML: m18912_1.5.cnxml XML that defines the structure and contents of the module, minus any included media files. Can be reimported in the editing interface. Learn more.

Version History

Version: 1.5 Mar 16, 2010 11:30 am +0000 by Kenneth Leroy Busbee
Changes:
Added a clairification on source code being possible versus ok (readable to humans). 

Version: 1.4 Jan 15, 2010 7:12 am +0000 by Kenneth Leroy Busbee
Changes:
Added Google Analytics.

Version: 1.3 Jun 1, 2009 2:47 pm +0000 by Kenneth Leroy Busbee
Changes:
Minor edits. Added definitions. 

Version: 1.2 Jan 5, 2009 10:49 am +0000 by Kenneth Leroy Busbee
Changes:
Fix examples.

Version: 1.1 Dec 13, 2008 9:59 am +0000 by Kenneth Leroy Busbee
Changes:
Initial module.

How to Reuse and Attribute This Content

If you derive a copy of this content using a OpenStax-CNX account and publish your version, proper attribution of the original work will be automatically done for you.

If you reuse this work elsewhere, in order to comply with the attribution requirements of the license (CC-BY 2.0), you must include

  • the authors' names: Kenneth Busbee
  • the title of the work: Documentation and Making Source Code Readable
  • the OpenStax-CNX URL where the work can be found: http://cnx.org/content/m18912/1.5/

See the citation section below for examples you can copy.

How to Cite and Attribute This Content

The following citation styles comply with the attribution requirements for the license (CC-BY 2.0) of this work:

American Chemical Society (ACS) Style Guide:

Busbee, K. Documentation and Making Source Code Readable, OpenStax-CNX Web site. http://cnx.org/content/m18912/1.5/, Mar 16, 2010.

American Medical Assocation (AMA) Manual of Style:

Busbee K. Documentation and Making Source Code Readable [OpenStax-CNX Web site]. March 16, 2010. Available at: http://cnx.org/content/m18912/1.5/.

American Psychological Assocation (APA) Publication Manual:

Busbee, K. (2010, March 16). Documentation and Making Source Code Readable. Retrieved from the OpenStax-CNX Web site: http://cnx.org/content/m18912/1.5/

Chicago Manual of Style (Bibliography):

Busbee, Kenneth. "Documentation and Making Source Code Readable." OpenStax-CNX. March 16, 2010. http://cnx.org/content/m18912/1.5/.

Chicago Manual of Style (Note):

Kenneth Busbee, "Documentation and Making Source Code Readable," OpenStax-CNX, March 16, 2010, http://cnx.org/content/m18912/1.5/.

Chicago Manual of Style (Reference, in Author-Date style):

Busbee, K. 2010. Documentation and Making Source Code Readable. OpenStax-CNX, March 16, 2010. http://cnx.org/content/m18912/1.5/.

Modern Languages Association (MLA) Style Manual:

Busbee, Kenneth. Documentation and Making Source Code Readable. OpenStax-CNX. 16 Mar. 2010 <http://cnx.org/content/m18912/1.5/>.