At 04:32 19/06/2002 -0700, Dave Tweed wrote: >Lawrence Lile wrote: > > > Here's a small addition to this (finally) serious list: > > > > The first line of my C or ASM file is a title, with the name of the file. > >Yes - when printed, it's good to know exactly which file it is. > > > Then the author, date, and purpose of the code > >The date should be handled as the first revision, below. Putting it here >is just redundant. > > > Next (as James Mentioned) is a series of comments identifying each revision > > level and why the revision was made and by whom, for instance: > > > > 1 LL 1 Jun 2002 New Program > > 2 LL 2 Jun 2002 Found bug in rs232() function > > 3. RW 3 jun 2002 Fixed bug introduce in fixing the last bug > > 4. LL 4 jun 2002 Found another bug that was introduced in > fixing > > the second bug which fixed the first bug etc. etc. > >Yes, except put the newest line first, as it's generally the most important >one. > > > Each revision is saved in a separate file, in case I need to refer to it > > later. I save a revision each morning first thing before I work on any > > code, and then every time I do anything that either 1. works or 2. took a > > long time to code. > >This quickly gets out of hand. Once you get to this level, you should be >using a revision-control system such as RCS, CVS, etc. And before getting to that level as well :) CVS can make your life so much easier.. >Such tools also enforce the creation of revision dates/comments (above), >but to be honest, I still tend to put them in the file as well, because I >can edit them there at the same time that I'm making the actual changes. >The RCS comments get put in only at the end, when checking in new versions, >and I tend to be in a hurry at that time, and produce very short and cryptic >descriptions. > >"Guillermo Rodriguez Garcia" wrote: > > - only tabs, no spaces. 4-spaces per indentation level. > >I have to second the comment about hard tabs with nonstandard widths. Yes, I also second that comment :) My original text was wrong, my bad. I never use tabs. G. >Just use spaces, then no one will have to guess what your tab width is. >I've seen 2, 3, 4, and 8, and it's a real pain when you try to edit someone >else's code. > >-- Dave Tweed > >-- >http://www.piclist.com#nomail Going offline? Don't AutoReply us! >email listserv@mitvma.mit.edu with SET PICList DIGEST in the body -- http://www.piclist.com#nomail Going offline? Don't AutoReply us! email listserv@mitvma.mit.edu with SET PICList DIGEST in the body