Re: EuGTK 4.7.5 available
- Posted by jimcbrown (admin) Dec 04, 2013
- 1772 views
Does that mean you create the html code as you type?
I am interested in the process. The o[ way is to use eudoc, creole (get html), then optionally tex (get pdf).
Why go to all that trouble when it's easier and faster to just hit some keys?
My snarky response is that it's more difficult (and slower) to "just hit some keys" and be able to generate the documentation in multiple formats.
I don't know about that. These days, it's pretty easy to convert from HTML to anything else. Especially if it's the clean, handwritten HTML that an experienced coder like irv would produce.
The various formats are all supported by the makefile, so it's pretty trivial to regenerate once you have your system configured.
Agreed. But getting the system configured properly is typically the hard part. (See _tom's post about tex.)
There's a lot less typing, since a lot of the boilerplate stuff is handled by the generation process, which results in improved consistency (for me, at least).
Agreed. But OTOH a good text editor probably supports templates and macros, which can go quite far in dealing with boilerplate stuff as well.
Besides I have never liked the clutter that results when all those doc strings are included In the source code.
To each his own. I find this easier, as the code and the documentation are all in one place.
I can also use the documentation that's right there in the code when that's more convenient than having it open in a browser or whatever.
If the only docs can't be opened with a text editor or a text-only web browser, I typically won't use them at all.
That said, I can work equally well when the docs are in code comments or in an external file. I open the source file twice in the former case, once in an editor to code and once in a text viewer simply to get at the docs.
I'm more likely to update the documentation as I go, and more likely to notice when they get out of sync.
Matt
This is the part that I've never quite gotten a handle on, myself.... ;)
