Path: utzoo!utgpu!jarvis.csri.toronto.edu!mailrus!ames!hc!lll-winken!uunet!cos!hqda-ai!yendor!gmg From: gmg@yendor.UUCP (Gary Godfrey) Newsgroups: comp.software-eng Subject: Re: comments on comments Message-ID: <5172@yendor.UUCP> Date: 25 Feb 89 18:36:06 GMT References: Distribution: usa Organization: AvaTech Inc. Reston, VA Lines: 59 From article , by ejp@abvax.icd.abnet.com (Ed Prochak): [stuff deleted] > Knuth has a system that allows this kind of development. I am looking > forward to trying it sometime. (when the schedule eases up a bit :^). > I assume you're referring to _Literate_Programming_/Web? I decided at one point to attempt the same thing (in a MUCH more simplistic fashion) under 'C'. All I do is put the "program documentation" in my 'C' comments in the form: /* * miscl stuff... * . * . * %PDOC% * * LATEX * commands + text can go here. * . * . * %ENDPDOC% */ Then all I have is a simple awk script that munges this stuff and converts all the .c files to .tex files. They are chained together by a single file which ties the output files together and provides some cohesion. It seemed to work well as an experiment.... The next thing that I want to do (to take this a step further :-) is to implement what Stallman did in gnu-emacs - put the On-line user documentation as part of the hard documentation. And further still, put the user docuemntation inside the actual code. So we then have something to the effect of: /* * This is a function: * %UDOC% * Press the key at this point in order to bring up the widget * screen. The F2 and F98 keys will envoke the goggle window and allow * you to spit 37 feet into the air. * %EUDOC% * %PDOC% * This implements the widget screen and goggle functions. It does this * by flamming the dib cretan and tossing the b-span behind it's back. * %EPDOC% */ Not yet..... > Edward J. Prochak Email: {cvedc,cwjcc,pyramid,decvax,masscomp,uunet}!abvax!ejp ----- If ever there was one, then I haven't seen it. In fact, if there wasn't one then I haven't seen it. A->B !A->B. B. Damn. Gary Godfrey - AVA Tech, Reston, VA Phone: (703)264-0074 UUCP: ..uunet!cyclops!media!yendor!gmg