OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.


Help: OASIS Mailing Lists Help | MarkMail Help

docbook message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [Elist Home]

Subject: Re: DOCBOOK: OT: DocBook and Literate Programming?

/ "Jeff Duska" <jeff@duska.com> was heard to say:
| The only idea I have is to start add the documenation in VB comments using
| either HTML markup or DocBook markup. Then create a tool that extracts the
| comments and code into a XML or SGML file. Then I could then user the
| SGMLTools for NT.

That's basically what's required. Literate Programming (as applied to
TeX, the program) goes even further.

I don't have any really good suggestions; I've tried to do this myself
a few times. Java and JavaDoc seem to come fairly close because
there's a good toolchain. I think you'll get the most benefit if you
can spend some time up front righting the tools that extract the
documentation from your code (or your code from the documentation,
it's hard to say which way around is better).

And then train yourself to always do it that way.

                                        Be seeing you,

Norman Walsh <ndw@nwalsh.com>      | All professional men are
http://www.oasis-open.org/docbook/ | handicapped by not being allowed
Chair, DocBook Technical Committee | to ignore things which are
                                   | useless.--Goethe

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [Elist Home]

Powered by eList eXpress LLC