Dev comments in code

Post feature requests to this forum and a pre-configured poll will automatically be created for you.
Post Reply

How important is this enhancement to you?

It's a critical enhancement that I must have.
1
17%
It's an important enhancement but others are more critical.
4
67%
I'd like to have it but it's not that important.
1
17%
I'd never use this feature.
0
No votes
 
Total votes: 6

evanb@firefold.com
Lieutenant, Jr. Grade (LT JG)
Lieutenant, Jr. Grade (LT JG)
Posts: 36
Joined: Mon Jul 21, 2008 3:45 pm

Dev comments in code

Post by evanb@firefold.com » Mon Oct 06, 2008 8:13 am

I'd like to personally put a request in for the developers to put more comments in code.

I think this has probably been one of the most difficult aspects of working with Able so far for our team. Especially when it comes down to figuring out able-specific coding and methods.

User avatar
Logan Rhodehamel
Developer
Developer
Posts: 4116
Joined: Wed Dec 10, 2003 5:26 pm

Re: Dev comments in code

Post by Logan Rhodehamel » Thu Oct 09, 2008 1:19 pm

It might be helpful from our perspective to have an example or two of where you mean. Sometimes when you are too familiar with a project, you have trouble knowing what areas will be hard for others to follow.
Cheers,
Logan
Image.com

If I do not respond to an unsolicited private message, it's not because I'm ignoring you. It's because the answer to your question is valuable to others. Try the new topic button.

User avatar
AbleMods
Master Yoda
Master Yoda
Posts: 5170
Joined: Wed Sep 26, 2007 5:47 am
Location: Fort Myers, Florida USA

Re: Dev comments in code

Post by AbleMods » Sat Oct 11, 2008 10:46 pm

~/Admin/Orders/Default.aspx is a pretty important page from a developer perspective. It makes for a huge resource of information for how certain things get done related to an order.

It has some commenting, but key functions like the OrderGrid_RowDataBound, OrderGrid_DataBound, BatchButton_Click have very few comments if any.

~/Admin/Marketing/Discounts/EditDiscountScope.aspx has very few comments.

~/Admin/Catalog/Browse.aspx.cs also has very few comments. It's the best place to learn how the product-category relationship is maintained but isn't very well commented.

My experience has found that the code comments are pretty good. There's a few files (mentioned above) that are less than stellar, but overall I've been pretty pleased. Everyone's mileage is different though, so more is always better.
Joe Payne
AbleCommerce Custom Programming and Modules http://www.AbleMods.com/
AbleCommerce Hosting http://www.AbleModsHosting.com/
Precise Fishing and Hunting Time Tables http://www.Solunar.com

Post Reply