HNHacker News
TopNewBestAskShowJobs

hoveringGoats

15 karma · joined November 14, 2014

submissionscomments
hoveringGoats··on Show HN: Doczar – explicit doc generation for many languages
If you touch nix at all you have tons of command line tools that require runtimes. Those runtimes were just prepackaged with your distro.

I'm glad you've had a good experience with godoc. My experience with other syntax scanners in other languages is that they always get things wrong. By the time you've added tags to correct the mistakes, you've done more work than doczar would've required you to do.

"Comments are most often read in the code in plaintext" which inspired me to make a new syntax that's more human legible in the source. If you only need to document an argument as being a Stream, it's as simple and clear as `@argument/Stream reader`, no useless sentence of text necessary. edit - or `@argument/Stream* reader` or `@argument/Stream[] readers`.

hoveringGoats··on Show HN: Doczar – explicit doc generation for many languages
Ah, but which should doczar be compatible with, doxygen or javadoc? A fundamental frustration I have with both of these projects is that their syntax is designed to annotate the results of a syntax scanner in their primary language, not to describe a structure from the ground up. I could potentially have worked from the syntax of an established "generalist" project such as NaturalDocs, but most of these were designed to mimic javadoc syntax.

Regarding performance, I've fed it some nasty directories and generation time is trivial. Doczar generates docs as fast as your hard drive can move them.

Thanks for looking!