Advanced

Self-documentation of code

Posted by Scott_Ruecker on · 2 comments
Linux User & Developer; By Richard Hillesley 		Mail this story
Print this story

The inadequacy or lack of documentation of software is a recurring issue. This applies just as often to proprietary software as it does to free software. Documentation of code has two main purposes: to make the code readable for other programmers, and to make the code useable. Good documentation of free software is vital for users, and contributing to the documentation (or translation to a minority language) of a free software project is a good way to get involved for those who don’t know where to start, or how to program, and want to know how it’s done. The problem is a shortage of recruits.

Full Story

  Nav
» Read more about: Story Type: News Story; Groups: Developer, GNU, Linux

» Get new stories by e-mail: nightly or as they are published

« Return to the newswire homepage

  Related stories
» More like this

Comments (2)

Jeff91 ·
"Two weeks ago only two people knew how this worked, myself and God. Now only God knows."
gus3 ·
Because God reads code, not documentation.

Plus, "when code and documentation disagree, they are both wrong."

Post a comment

A free account is needed to post. Write your comment here first: your text is kept in this browser while you sign up or log in, and is waiting for you when you come back.

Your message:
|||||
10
Markdown: **bold**, *italic*, [text](https://link), - lists, > quotes, $x^2$ for math. Formatting help

Sign up and post (it is free)  or  Log in and post