What do people use to document boo code?
Do you know what can be used to generate documentation for Boo code?
![]()
What do people use to document boo code?
Do you know what can be used to generate documentation for Boo code?
![]()
SharpDevelop IDE has a convertor.
What i mean was, do you know of any BOO documentation tool?
If you add comments to .boo codes, an App would pick it up and create documentation for Boo classes, Boo functions, Boo procedures.
The only thing Iāve seen mentioned is NDoc. But to be honest, I have yet to find any bit of Boo code long enough or complex enough that Iād want a separate file for the documentation. Just add docstrings appropriately at each class and def.
ask this on the google boo group. i researched this a couple months ago but Iām afraid I forgot all the details.
thereās ndoc, which is actually kind of discontinued I think? and whatever the replacement is. I remember vaguely that ndoc uses .net IL introspection to figure out a lot of stuff which ends up breaking on new boo code. or maybe i just made that up?
and jdoc and related families just end up using plain text by default (that is, no real syntax parsing) because boo syntax isnāt exactly a popular thing.
and you canāt really use tools designed for python because of the type inference semantics.
which means youāre pretty much left with the usual: docstrings and whatever xml-comments of course you put above the functions.
itās unfortunate because, from what I could tell, Ndoc was perfect around 2008 or 2010.
again, though, ask on the boo group. a lot of the compilation pipeline is so exposed that i wouldnāt be surprised if thereās an āautomaticā documentation system sort of generated during compilation as a byproduct of the parser. you could probably write one yourself easily via Boo.Lang.Compiler.Ast. just create a module level attribute (AbstractAstAttribute), override Apply(Node), and loop through everything. Look at boo/ast.model.boo at master Ā· bamboo/boo Ā· GitHub for the actual syntax.