[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]

[dm-devel] [RFC] dm-writeboost: Plan to add comments. Needs help to make an objective list of where to comment



Hi,

I am thinking of adding more comments on the source code
according to the Alasdair's advice.

According to the Chapter 8 "Commenting" in Documentation/CodingStyle
WHAT it does should be commented
while HOW it works should not be but should be explained by the source code.

I was believing that only about the design issue
should be commented for the code quality.
But, on the second thought,
Linux kernel is a huge OSS 
that developers are living different timezone
and in different physical locations.
So, comments are almost all the information
that they can get beside the source code
because we can't easily chat with each other and ping pong Q&A.
That I am living in Japan might make the situation even worse.

Now that dm-writeboost is consist of 3.5k lines of code
and more 500 or 1000 lines of comments added
doesn't affect the maintainability so much.
Therefore, commenting will be paid in case of dm-writeboost.

I will be starting from commenting on WHAT it does
in the source code
including adding explanation on what the routine does
in front of the routines.

But the problem is that
I have no idea where to write comments at all.

I want to make an _objective_ list of where to comment.
Someone help me make the list?
I ask you to
read thru the code,
pick up where you couldn't understand or feel needing comments
and then report the list to me.
It will be helping a lot.

Thanks,
Akira


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]