[Mono-docs-list] looking to help..
Joe Betz
jbetz@pocketinet.com
Sat, 9 Feb 2002 21:03:03 -0800
> > I am filling completed files in System.Web.UI.WebControls with
> > reasonably concise <remarks> and <summary> tags. I would like to
> > provide more extended documentation as well. For now I plan to
write a
> > plain-text (tagless) page for each file I document with examples and
> > explanations. Should I do this? Also, any standards I should
follow
> > beyond those mentioned in the EMCA section?
>
> We are trying not to put documentation embedded into the source code,
> the rationale for this can be found here:
>
> http://www.go-mono.com/classlib-doc.html
Ah, this changes my plans. What is the status of external
documentation? Should I focus on one of the documentation tools, like
docstub, or a XML Schema for external documentation instead of writing
more embedded documentation?
Joe Betz