Tangential thought, but I always loved that Factor's documentation is separate from the actual source code (i.e., that foo.factor's docs live in foo-docs.factor). In really any other language I can think of, you have to clutter what might otherwise be easy-to-read code with gobs of explanations, examples, warnings, doctests, markup, etc. I always wondered why using inline comments for documentation generation is the default for various programming languages, when it seems so ugly.
Not that other modes of documentation aren't useful. I just sometimes feel like I'm alone in appreciating this particular point. :P Carry on, --Alex Vondrak ________________________________________ From: Jon Harper [jon.harpe...@gmail.com] Sent: Wednesday, August 29, 2012 11:03 AM To: factor-talk@lists.sourceforge.net Subject: Re: [Factor-talk] Literate Programming Short answer: no. The factor documentation system is described here: http://docs.factorcode.org/content/article-writing-help.html Interestingly, the documentation system is written in factor and documented using itself, so this html page is a good example of the output it produces. Jon On Wed, Aug 29, 2012 at 1:41 AM, graham telfer <gakouse...@hotmail.com<mailto:gakouse...@hotmail.com>> wrote: Does Factor have any tools to develop programs using a literate programming method? Something like Bird notation used with Haskell or a document generator like DocGen with VFXForth. The usual thing in code is to mark the comments and leave the code, but in a literate programming approach (where there is going to be more comment than code) marking the code explicitly would be better. ------------------------------------------------------------------------------ Live Security Virtual Conference Exclusive live event will cover all the ways today's security and threat landscape has changed and how IT managers can respond. Discussions will include endpoint security, mobile security and the latest in malware threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/ _______________________________________________ Factor-talk mailing list Factor-talk@lists.sourceforge.net<mailto:Factor-talk@lists.sourceforge.net> https://lists.sourceforge.net/lists/listinfo/factor-talk ------------------------------------------------------------------------------ Live Security Virtual Conference Exclusive live event will cover all the ways today's security and threat landscape has changed and how IT managers can respond. Discussions will include endpoint security, mobile security and the latest in malware threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/ _______________________________________________ Factor-talk mailing list Factor-talk@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/factor-talk
