Tags:
create new tag
, view all tags
The Subversions on-line book includes a statement that the program examples in the book are not necessarily demonstrative of good programming style (from Conventions Used in This Book (I've seen similar statements in other books which touch on programmming):

Note that the source code examples are just that-examples. While they will compile with the proper compiler incantations, they are intended to illustrate the problem at hand, not necessarily serve as examples of good programming style.

It struck me that it could be a whole lot better if such examples were demonstrative of good programming style — then anybody who bothered to study the examples would (or might) absorb some good programming practice by "osmosis".

I recognize that "good programming style" can be somewhat nebulous (sp?) with many opinions about the best practice, but %SECTION{summary}%I thought it might be a good idea if a group of interested people got together and were willing to do things like review examples in programming books to do something along the lines of confirming that they were indicative of at least reasonable programming practice.

I guess I'd want to weed out the extremes somehow. (I don't even know what those are, I'm not much of a programmer myself (although I was once "educated" as a programmer, on the order of 30 years ago), so I don't really have good examples of those extremes. Maybe, to make one up, if someone felt good programming practice required a comment explaining every line of code, that might be an extreme that should be discouraged.

Just wondered whether anybody else has thoughts on this.

See:

Contents

Text

Contributors

  • () RandyKramer - 18 Jan 2004
  • If you edit this page: add your name here; move this to the next line; and if you've used a comment marker (your initials in parenthesis), include it before your WikiName.

Revision Comment

%SECTION{last_revision}%
  • %DATE% —

Page Ratings

Topic revision: r1 - 2004-01-18 - RandyKramer
 
  • Learn about TWiki  
  • Download TWiki
This site is powered by the TWiki collaboration platform Powered by PerlCopyright 1999-2017 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding WikiLearn? WebBottomBar">Send feedback
See TWiki's New Look