[Uml-devel] Docs in cpp

Andi Fischer andi.fischer at hispeed.ch
Wed Jun 25 17:36:55 UTC 2008


Gopala Krishna wrote:
> Hi,
>
>  i was thinking to document the classes, methods etc in .cpp file
> rather than the .h file
> This according to me helps to get a quick overview from header file
> while not compensating with the documentation as well.
>
> Can i follow this in my code ? Any objections ?
>
>   

Hi Gopala,

I support your idea.
As you wrote, it gives a quick overview of the class.
The description and the comments are where the code is and therefore 
more helpful.

Regards,
Andi




More information about the umbrello-devel mailing list