Re: [ACFUG Discuss] documentation

[Teddy Payne]

I see a great deal of adhoc commenting styles that do not have a semblance
of coherence.

When using CFCs, the hint is invalueable.

When using version control, comments made on check-in are very helpful.

Dreamweaver uses design notes on code templates.

I have seen external documents with code explnation.

The primary issue and thus need is that when you comment code that you
should be able to do so at the same time that you code.  You really do not
want to create several bodies of code or commenting documents.

It is also a management decision if you want to implement fusedocs or
concreate commenting versus adhoc commenting that can be anywhere.

A con to production commenting is that you really don't want your production
code with ehavy amounts of comments.

I would suggest staging documentation that would record the API trhough
version control with good code hints.

Teddy

On 2/19/07, John Mason <[EMAIL PROTECTED]> wrote:


 We're talking about implementing a formal documentation procedure
here. Besides for fusedocs, what other options are people currently using
out there and what do you see as the pros and cons.

thanks in advance,
John
[EMAIL PROTECTED]



-
To unsubscribe from this list, manage your profile @
http://www.acfug.org?fa=login.edituserform

For more info, see http://www.acfug.org/mailinglists
Archive @ http://www.mail-archive.com/discussion%40acfug.org/
List hosted by FusionLink 
-





--
Teddy R. Payne
G-Talk: [EMAIL PROTECTED]

Adobe Certified ColdFusion MX 7 Developer
Atlanta ColdFusion User Group (ACFUG)
Atlanta Flash & Flex User Group (AFFUG)



-
To unsubscribe from this list, manage your profile @ 
http://www.acfug.org?fa=login.edituserform


For more info, see http://www.acfug.org/mailinglists
Archive @ http://www.mail-archive.com/discussion%40acfug.org/
List hosted by http://www.fusionlink.com
-

[ACFUG Discuss] documentation

[John Mason]

We're talking about implementing a formal documentation procedure here.
Besides for fusedocs, what other options are people currently using out
there and what do you see as the pros and cons. 
 
thanks in advance,
John
[EMAIL PROTECTED]
 
 



-
To unsubscribe from this list, manage your profile @ 
http://www.acfug.org?fa=login.edituserform

For more info, see http://www.acfug.org/mailinglists
Archive @ http://www.mail-archive.com/discussion%40acfug.org/
List hosted by http://www.fusionlink.com
-