This project is read-only.

Are there any plans to add comments to the souce code?

Jan 19, 2011 at 5:49 PM

At least for public API, its very hard sometimes to guess what is doing particular method. And also this will speed up learning Orchard. Do you have any plans for this?

Jan 19, 2011 at 6:03 PM

We have plans for API documentation but not for source code comments. Actually, opinions diverge on code commenting.

Jan 19, 2011 at 6:34 PM

API documentation is cool. The fact that opinions diverge on code commenting is logical and understandable, I also not a very big fun of documenting internal stuff or having inline comments. I think that comments often just a way of saying "hey, I failed writing a readable code here, so I wrote a comment", but have no idea why documenting public contracts is a bad thing.

Maybe this is a "holy war" question, but probably it is better to ask community (with a kind of poll) if they prefer to have comments or not? (again I mean public contracts only).