Re: Javadoc comments in kernel source?

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

 



If you write good code, you really don't need comments to read it, so
you should take that has your basis (I'm not saying don't comment, but
you should really think about why you are commenting and if it's useful
to other programmers that will read the code).

Dave

On Thu, 2004-06-10 at 18:19, Timur Tabi wrote:
> Hi,
> 
> I'm working on a driver that I might try to get incorporated into the 
> official Linux kernel source tree.  One of the things I've noticed while 
> looking at the current Linux kernel source code is that it's very poorly 
> documented, at least by my standards.
> 
> For my code, I want to add lots of Javadoc-style comments.  For 
> instance, I comment every function and structure, and almost every local 
> variable.
> 
> Would Linus and/or his lieutenants reject my code because it's commented 
> too much?

--
Kernelnewbies: Help each other learn about the Linux kernel.
Archive:       http://mail.nl.linux.org/kernelnewbies/
FAQ:           http://kernelnewbies.org/faq/


[Index of Archives]     [Newbies FAQ]     [Linux Kernel Mentors]     [Linux Kernel Development]     [IETF Annouce]     [Git]     [Networking]     [Security]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux RAID]     [Linux SCSI]     [Linux ACPI]
  Powered by Linux