[Mono-dev] Documentation synchronization

Jacob Ilsø Christensen jacobilsoe at gmail.com
Fri Sep 15 10:24:08 EDT 2006


On 9/15/06, Marek Sieradzki <marek.sieradzki at gmail.com> wrote:
> On 9/15/06, Jacob Ilsø Christensen <jacobilsoe at gmail.com> wrote:
> > Hi.
> >
> > On 9/15/06, Michael Schurter <michael at synthesyssolutions.com> wrote:
> > > Hi Jacob,
> > >
> > > Jacob Ilsø Christensen wrote:
> > > > Hi again.
> > > >
> > > > Just out of curiosity. Why was this documentation approach chosen as
> > > > opposed to e.g. source code doc comments?
> > > >
> > > > A big advantage of source code doc comments is that they are available
> > > > as you do the actual coding. With the current approach you have to
> > > > look in a separate xml file to see documentation for a specific class
> > > > or method or did I miss out on something?
> > >
> > > If I remember correctly its to make translation easier.  Please don't
> > > top post.
> > >
> >
> > So code documentation is actually translated in mono?
> >
> No but there is "en" folder. It doesn't make any sense to me to
> translate mono documentation to other languages as the English version
> is not complete. But if someone wants to do it's possible.
>

So as of now there are no real reasons to have documentation in
separate xml files? Is it probable that people will start translating
code documentation?

Also why is this approach so much better than doc comments? With doc
comments xml files can also be generated which then can be translated.



More information about the Mono-devel-list mailing list