Documentation

Developer
May 19, 2009 at 8:44 PM

The code desperately needs documentation in english.  Right now it is a major weakness.  If you are not strong in english, I can refine any translation attempt.

Coordinator
May 21, 2009 at 5:54 PM

Thank you for your suggestion and I want to work together cooperatively.

Here is a documentation of C#Mail but it is under construction.

http://www.higlabo.com/Mail/index.html?from=codeplex

Long time I didn't write these documentaion.

I try to restart writing this documentation if I create time to write it.

 

If you cooperate with me,what I want to is...

1--I write new html file

2--You download html file on above url

3--You modify this file to appropriate spelling

4--send me new html file.

If you cooperate with me, I'm very glad to.

regard.

 

Developer
May 23, 2009 at 1:30 AM

I mean the API documentation in the source.  All the methods and properties should be documented in english.  The website is nice, but if its not part of the project on cdeplex, it will undoubtedly get lost over time.

Coordinator
May 26, 2009 at 3:41 PM

I see.It is real true that we need document in English.

One thing I want to know is how manage English comment and Japanese comment (and other language...) in my source code.

We can output comment to xml file but this has one problem.

We output xml file in English and create xml file written by Japanese from generated English xml file.

If I add some method to source,output xml file in English,I must add method to xml file written in Japanese.

I don't know it is standard way to manage comment in multi language.

If someone know better way to manage multi language comment,please show me how to manage it.

 

 

 

Developer
May 28, 2009 at 11:23 AM

My suggestion is to translate the comments to english, as its probably the most widely understood language in the open source community.  If you make me a contributor, we can work together to perfect the documentation.

Coordinator
Jun 2, 2009 at 4:16 PM

OK.

Now I'm writing some code in my local PC,please wait for updating to new source.

I will complete writing new code within few days.

Developer
Jun 2, 2009 at 4:17 PM

ok, sounds good.