Path: utzoo!utgpu!news-server.csri.toronto.edu!rpi!uwm.edu!linac!pacific.mps.ohio-state.edu!zaphod.mps.ohio-state.edu!unix.cis.pitt.edu!pitt!willett!ForthNet
From: ForthNet@willett.pgh.pa.us (ForthNet articles from GEnie)
Newsgroups: comp.lang.forth
Subject: Formatting Forth source code
Message-ID: <2755.UUL1.3#5129@willett.pgh.pa.us>
Date: 13 May 91 11:56:56 GMT
Organization: (n.) to be organized.  But that's not important right now.
Lines: 27

Category 2,  Topic 13
Message 22        Fri May 10, 1991
D.RUFFER [Dennis]            at 22:30 EDT
 
Gene, I also have been influenced by Kim Harris' coding conventions. For those
who have never seen it, find the 1985 FORML Conference Proceedings.  Pages 143-
74 contain his paper on "Forth Coding Conventions".  It is worth reading by
anyone who is concerned about programming style.

Gene, you also mentioned "shadow" blocks.  For those not familar with them,
they are a mapping of source blocks to documentation blocks in a 1 to 1
relationship.  In some cases, the second half of the file is reserved for
them, in others a whole nother block file is created to hold them.  They allow
a simple facility to be created to manage them (i.e. one word to switch back
and forth).  However, although I use them, I've found that a block is even
more limiting for documentation than it is for source.  I'm always running out
of room and then I have to leave something out.  While they do accomplish the
goal of getting the documentation both out of the way of the source and
connected to it at the same time, they are not the panacea that I have been
searching for.

DaR
-----
This message came from GEnie via willett.  You *cannot* reply to the author
using e-mail.  Please post a follow-up article, or use any instructions
the author may have included (USMail addresses, telephone #, etc.).
Report problems to: dwp@willett.pgh.pa.us _or_ uunet!willett!dwp