couple of ideas for "Document Declaration"

Yngve Inntjore Levinsen yngve.levinsen at
Thu Mar 29 12:53:38 UTC 2012


I was just using the "Document Declaration" now (in C++), and there are a 
couple of points I figured might be worth while suggesting.

1. If the function is a void, what about not adding the line "@return void"? I 
don't see how that information is useful...

2. What about adding "@author %{fullname} <%{email}>"? In the snippets these 
macros are defined and will automatically put my name and e-mail. To me it is 
quite useful on a bigger project to know who wrote a given function/class...?

3. You could consider to add the line "@date %{year}" (or perhaps year-month) 
as well..?


More information about the KDevelop mailing list