Best Practices for Documenting Programmed Code

By James Seymour
$5.00 Rating: Not yet rated.
Published: July 19, 2012
Words: 2,368 (approximate)
Language: English

Short description

The purpose of this document is to understand why documenting programming code is extremely important.

Extended description

Since the early days of computing, the developed programming code has been documented with basic information so that any person could access the script and see the history of the code. The truly sad fact is that any documentation has quickly fallen into not best practices but more into no practices. This must change to the enforced use of documentation of each script file and code block so that anyone at any time can understand what the code means.

For those who defiantly decline to document, let me quote the authors, Peter Scott and Ed Wright, who stated, “We know, real programmers don't document. ‘It was hard to write; it should be hard to understand.’ We feel your pain. However, the sanity you save may be your own. You could hop between jobs sufficiently rapidly that you never have to revisit a program you wrote more than six months ago. Or you could document it so you'll understand what you did.”

Tags

programming, programming reference, programming code, documenting programming code

Available ebook reading formats

Single purchase gains access to all formats. How to download ebooks to e-reading devices and apps.

Format	Full Book	Sample First 10%
Online Reading (HTML, good for sampling in web browser)	Buy	View sample
Kindle (.mobi for Kindle devices and Kindle apps)	Buy	Download sample
Epub (Apple iPad/iBooks, Nook, Sony Reader, Kobo, and most e-reading apps including Stanza, Aldiko, Adobe Digital Editions, others)	Buy	Download sample
PDF (good for reading on PC, or for home printing)	Buy	No sample available
RTF (readable on most word processors)	Buy	No sample available
LRF (Use only for older model Sony Readers that don't support .epub)	Buy	Download sample
Palm Doc (PDB) (for Palm reading devices)	Buy	Download sample
Plain Text (download) (flexible, but lacks much formatting)	Buy	No sample available
Plain Text (view) (viewable as web page)	Buy	No sample available

Reviews

Log-in to write a Review   Log-in to add a Video Review

This book has not yet been reviewed.

Reason for report:
— Select a reason — Book is or contains spam Book infringes copyright Same content is published elsewhere with different author (for ex., by private-label rights) Duplicate Incomplete work (such as sample or serial) Should be marked adults-only Category is inappropriate Poorly formatted Nudity or other inappropriate content on cover Nudity or other inappropriate visual content in book Inappropriate erotica content Cover image is improper Content is inappropriate Other violation of Terms of Service Other reason not shown above.

Additional details: