<br><br><div class="gmail_quote">On Wed, Mar 9, 2011 at 17:31, Francesco Nwokeka <span dir="ltr"><<a href="mailto:francesco.nwokeka@gmail.com">francesco.nwokeka@gmail.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex;">
Hello to all devs!<br>
I'm new to telepathy so let me introduce myself. I'm an anglo-italian( can you say that? )<br>
student from Italy and I'm currently finishing my studies at the university of Padova ( software<br>
developer ).<br>
I'm writing to tell you about a problem that doesn't affect me alone, but all those people who want<br>
to contribute to a project that's already started and quite big.<br>
<br>
This problem is getting to know the code. The eyes of a new contributor are different from those of<br>
the devs who started the project. We "new ones" have to get to know how the data is handled, which<br>
classes do what and so on. This problem can be avoided with well commented code. Even little things<br>
help so that instead of reading the whole function, you can eaisily tell what a certain function<br>
does by simply reading its comment.<br></blockquote><div><br></div><div><meta http-equiv="content-type" content="text/html; charset=utf-8">Fair enough. The question is, where should be the method comments? I'd vote for the .cpp file, because sometimes I just want to open the header file and have a quick look at what methods it provide, in this case, the comments are getting in the way. </div>
<div><br></div><div>What do you think? Comment methods in implementation and the important rest, which is only in header, comment in header (enums etc).</div><div><br></div><div>Marty</div><div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex;">
<br>
I'm not telling off anybody because I'm in no position to do so, but I think it would ease things for<br>
everyone because once telepathy becomes really-big and it's code is not well commented, i doubt new<br>
contributers will find their way easily around the project.<br>
For what I know that's the major problem when starting to patch new code for an open source project.<br>
<br>
So please don't be offended by this mail, it's just my opinion and as I already said, i'm not writing<br>
to tell anyone off, but to make a suggestion that in my opinion can make life easier for everyone :)<br>
<br>
Cheers,<br>
<font color="#888888"> Francesco Nwokeka<br>
_______________________________________________<br>
KDE-Telepathy mailing list<br>
<a href="mailto:KDE-Telepathy@kde.org">KDE-Telepathy@kde.org</a><br>
<a href="https://mail.kde.org/mailman/listinfo/kde-telepathy" target="_blank">https://mail.kde.org/mailman/listinfo/kde-telepathy</a><br>
</font></blockquote></div><br>