Re: [webkit-dev] about QtWebKit documentation

2011-01-30 Thread Kanazawa Yoshiko
Thank you so much for your reply. But someone advised the person who posted a similar question(below link) to post that question to this mailing list. Maybe there are not so many documents,I think. And I found a good article. http://webkit.org/coding/technical-articles.html http://taligar

Re: [webkit-dev] coding style and comments

2011-01-30 Thread Maciej Stachowiak
On Jan 30, 2011, at 4:41 PM, Ryan Leavengood wrote: > On Sunday, January 30, 2011, Maciej Stachowiak wrote: >> >> I'll go the other way and point out some example of comments that I think >> are poor. > > This file is terribly commented, I agree, but cherry picking a really > bad file isn't t

Re: [webkit-dev] coding style and comments

2011-01-30 Thread Maciej Stachowiak
On Jan 28, 2011, at 11:34 AM, Maciej Stachowiak wrote: > > > In general, I agree with what Eric and Darin said about this topic. By the way, here are some good resources that align well with the traditional WebKit project philosophy of commenting: My new favorite statement about this topic

Re: [webkit-dev] coding style and comments

2011-01-30 Thread Ryan Leavengood
On Sunday, January 30, 2011, Maciej Stachowiak wrote: > > I'll go the other way and point out some example of comments that I think are > poor. This file is terribly commented, I agree, but cherry picking a really bad file isn't the best way to make a point IMO. Maybe the solution here is bette

Re: [webkit-dev] coding style and comments

2011-01-30 Thread Maciej Stachowiak
I'll go the other way and point out some example of comments that I think are poor. /// // BlobResourceSynchronousLoader

Re: [webkit-dev] coding style and comments

2011-01-30 Thread Adam Barth
As an example of a harmful comment, this comment just wasted 15 minutes of my time: http://trac.webkit.org/browser/trunk/Source/WebCore/dom/Document.h#L351 The comment was true when written (although confusing because I thought it meant that these functions are virtual so we should avoid calling

Re: [webkit-dev] coding style and comments

2011-01-30 Thread Adam Barth
On Sun, Jan 30, 2011 at 7:40 AM, David Kilzer wrote: > An interesting case study would be the (still ongoing?) refactoring of the > loader code over the past few months (thanks to Adam Barth and others).   Is > it easier to understand now than before the refactoring started?  How many > comments w

Re: [webkit-dev] coding style and comments

2011-01-30 Thread David Kilzer
On Jan 28, 2011, at 9:36 AM, Peter Kasting wrote: > On Thu, Jan 27, 2011 at 4:27 PM, Simon Fraser wrote: > I think we have a distinct lack of comments that help novices to understand > the code. I feel that we almost have a "privileged few" mentality in some > code; if you can't figure it out b