Commenting the code

Aug 17, 2010, 12:09 pm
#1
Joined: Jan 25, 2008
Occupation: Turns out I can't have a cool avatar, I'll just put crap in it.
Location: 48kg / 105 lbs
Interests: My name is Failbert
Posts: 697
As I said at IVANcon, I am interested in commenting the code - which sounds like a good foundation for future coders to get in touch faster.

I already started "here and there" in the main files. Right now I am describing the files themselves, which one contains which functions etc., on my way to describing how particular functions work, what are the classes etc.

It will be a hell of a task, but it looks like something that will appreciate any bit of help (perhaps we could wiki it?), so I invite everybody to discuss!
Aug 19, 2010, 2:27 pm
#2
Joined: Jul 29, 2010
Posts: 3
Have you published your work somehere? Are you going to? In what format?
Aug 20, 2010, 3:38 am
#3
Ernomouse's avatar
Master mine stomper


Joined: Dec 16, 2007
Occupation: Pouring molten bronze in sand
Location: In the cold end
Posts: 2,047
I believe it\\s easy enough to just tell what you're working on for now. When we\\ve got a place to share our work, we'll share it.
Jump to