<br><br><div class="gmail_quote">2012/3/29 Yngve Inntjore Levinsen <span dir="ltr"><<a href="mailto:yngve.levinsen@gmail.com">yngve.levinsen@gmail.com</a>></span><br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
Hi,<br>
<br>
I was just using the "Document Declaration" now (in C++), and there are a<br>
couple of points I figured might be worth while suggesting.<br>
<br>
1. If the function is a void, what about not adding the line "@return void"? I<br>
don't see how that information is useful...<br></blockquote><div><br>+1<br><br></div><blockquote class="gmail_quote" style="margin:0pt 0pt 0pt 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
<br>
2. What about adding "@author %{fullname} <%{email}>"? In the snippets these<br>
macros are defined and will automatically put my name and e-mail. To me it is<br>
quite useful on a bigger project to know who wrote a given function/class...?<br>
 <br></blockquote><div>On a bigger project there will usually be any number of authors on a given function/class. Wouldn't it make more sense to use the version control system to retrieve that information?<br></div><div>
 </div><blockquote class="gmail_quote" style="margin:0pt 0pt 0pt 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
3. You could consider to add the line "@date %{year}" (or perhaps year-month)<br>
as well..?<br>
<br></blockquote><blockquote class="gmail_quote" style="margin:0pt 0pt 0pt 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
Cheers,<br>
Yngve<br>
<br>
_______________________________________________<br>
kdevelop mailing list<br>
<a href="mailto:kdevelop@kdevelop.org">kdevelop@kdevelop.org</a><br>
<a href="https://barney.cs.uni-potsdam.de/mailman/listinfo/kdevelop" target="_blank">https://barney.cs.uni-potsdam.de/mailman/listinfo/kdevelop</a><br>
</blockquote></div><br><br clear="all"><br>-- <br>- When the split is pulled, mr. Grenade is no longer our friend<br>