[prev in list] [next in list] [prev in thread] [next in thread] 

List:       koffice-devel
Subject:    coments
From:       "Michael Marcucio" <michaelmarcucio () hotmail ! com>
Date:       2002-01-13 22:15:35
[Download RAW message or body]

quick question for all of you koffice developers,
is there any kind of standard i should follow when i comment my code?
i usually do someting to the effect of:
/**************************************
FUNCTION:  invokeHandler
PARAMS:       Header &op:           the header of the particular atom
                        Q_UINT32 bytes:   the length of the atom
DESCRIPTION: this function finds the type of atom and bla bla bla...
CHANGES:   mjm2    01/04/2001   what i did
**************************************/
is this a good way of doing this? i would like to keep the commenting 
consistant with koffice standards.
thanks,
mike

_________________________________________________________________
Join the world’s largest e-mail service with MSN Hotmail. 
http://www.hotmail.com

_______________________________________________
koffice-devel mailing list
koffice-devel@mail.kde.org
http://mail.kde.org/mailman/listinfo/koffice-devel
[prev in list] [next in list] [prev in thread] [next in thread]