Chaos Project

Featured Projects => Advanced RPG Creator => ARC Reactor Engine => Topic started by: Blizzard on March 10, 2011, 02:20:56 pm

Title: Documentation
Post by: Blizzard on March 10, 2011, 02:20:56 pm
Should we add documentation right away? If we do it now, it won't be a bother to do it later one day. I think that we should do it at least with finished classes and after heavy rewrite and refactoring of classes.
If you agree with this, I will document the first few classes and you can follow that example from then on.
Title: Re: Documentation
Post by: Ryex on March 10, 2011, 02:25:53 pm
are you talking about commenting the classes? I'm fine with that. I tend to write documentation for code as I go anyway.
Title: Re: Documentation
Post by: ForeverZer0 on March 10, 2011, 04:43:24 pm
I wouldn't have any problem with it either. I think it will help save time later, as well. In my experience, its best to do this as you write the code and everything is fresh in your mind.
Title: Re: Documentation
Post by: Blizzard on March 10, 2011, 04:46:10 pm
Alright, I have documented the 5 classes that have been written so far.

EDIT: I have noticed that some of you write // instead of ///. That won't work. // is a comment while /// is a documentation string.

EDIT: Also, documentation only goes into headers. No need to put anything into source files.