[Mono-list] Re: [Mono-hackers-list] Re: Patch for mcs

Atsushi Eno atsushi@ximian.com
Wed, 03 Nov 2004 18:50:17 +0900


>    Looks like I made you upset... and I hate my behaviour. Apologies
> if this is the case. I never intended to.

Oh, np, I did't :)

Well, I dug into the "universal documentation" idea. And now
I think it would be problematic.

According to the C# /** ... */ rule, heading '*' characters in
each comment line must be removed when (and only when) it
starts with spaces and '*'. It is C# specific rule. (well, mcs
is C# compiler ;-)

Also, it need to reject invalid comments and it must not collect
such invalid lines. For example, comments which are put immediately
before a get accessor is invalid (CS1587 warning will be raised):

public class Foo {
     public string FooProperty {
         /// This is an invalid comment and must not be collected
         get { return ""; }

So, I guess you cannot expect any arbitrary documentation grammar
to conform to C# documentation/tokenization rules.

>    As such, I will need to update only driver.cs leaving all code
> exactly same (in my code-base against mcs) when I deal with document
> generation.

Please clarify; do you actually have working functionality? If not,
why do you need to commit your changes to CVS before you finish
the actual document generation functionality?

Atsushi Eno