My source comments usually vary depending on the objects I am working with....
DAO and Beans are pretty much self explanatory to developers familiar with Patterns and OOP. Occasionally with those I'll include a short doc on what my definition of "Bean" and "DAO" are for the project and what they are expected to do/not do. Same goes for any standard objects that you really just make a bunch of and they all behave the same. The business logic layers prolly require the most source documentation since you're creating behaviors in the application that are likely to be the most confusing to developers that come along after you. The presentation stuff is mainly HTML so I don't really think it needs much commenting usually beyond organizational guides like "this div starts here" "this div ends here". -Cameron On 1/26/07, Mike Tangorre <[EMAIL PROTECTED]> wrote: > Ok, how many of you adequately document your source code? By adequately I > mean to a point where another developer can jump into an application and be > productive in a short period of time. > > Also, if time is tight on a project, how many feel source code documentation > is the first place that takes a hit? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~| Upgrade to Adobe ColdFusion MX7 Experience Flex 2 & MX7 integration & create powerful cross-platform RIAs http:http://ad.doubleclick.net/clk;56760587;14748456;a?http://www.adobe.com/products/coldfusion/flex2/?sdid=LVNU Archive: http://www.houseoffusion.com/groups/CF-Community/message.cfm/messageid:225877 Subscription: http://www.houseoffusion.com/groups/CF-Community/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=11502.10531.5
