[ros-dev] top-level source header

Casper Hornstrup ch at csh-consult.dk
Wed Oct 19 09:20:16 CEST 2005


> I suggest something as follows:
> 
> /*
>  * PROJECT:     ReactOS Kernel
>  * LICENSE:     GPL - See COPYING in the top level directory
>  * FILE:        ntoskrnl/ex/mutant.c
>  * PURPOSE:     section of the kernel
>  * PROGRAMMERS: Alex Ionescu (alex at reactos.org)
>  *              David Welch (welch at cwcom.net)
>  */
> 
> Which is exactly what the kernel uses right now.
> 
> Best regards,
> Alex Ionescu
[CSH] Yes, less unneeded information is better.
People will tend to forget updating the headers.
Actually I'd prefer if there isn't any information
in the header which is different from file to file.
You can lookup the information in the PROGRAMMERS
field in the repository. The PURPOSE field is
not needed as you should be able to get the same
information from the filename and the code in the
file. If you can't see the purpose from this, then
the code isn't as clear as it could be. It's kind
of like documenting your way out of unreadable code.
The information in the FILE field is already
displayed in your editor. We should not
misrepresent or not represent copyrights, so that
should be there. We also reuse code from external
projects and it's important to keep the copyright
notices around. The less information there is to
maintain, the more likely it is kept up to date.

/*
 * PROJECT:   ReactOS Kernel
 * LICENSE:   GPL - See COPYING in the top level directory
 * COPYRIGHT: Copyright (C) 2004-2005 John Doe
 *            Copyright (C) 2005 Jane Doe
 */

Casper



More information about the Ros-dev mailing list