Home   Info   DevZone   Wiki  
UsersWeb  |  MainWeb  |  InfoWeb  |  DevZoneWeb  |  SupportWeb
[ CodingCopyrightConventions ] [ not logged in ] [ Web: Imported ] goto:  options
[ get info on or edit ] [ login or new user ] [ list of topics, hubs & nodes, or recent changes ]

I propose that we put a header comment at the top of each java file, describing the class contained within. Here is an example for a file named Example.java see the whole file at OrgJosExampleJava 


package org.jos;

/*

JOS-A FREE JAVA BASED OPERATING SYSTEM
Copyright (C) 1998 JOS Organization

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to:

Free Software Foundation, Inc.,
59 Temple Place - Suite 330,
Boston, MA  02111-1307, USA.

To view the on-line version go to:
http://www.fsf.org/copyleft/gpl.html

Description of class:
The Example class serves as an example of a class. It is not useful
for doing anything. Rather, it serves as an example of how to code
using the coding conventions described in the CodingConventions
section of the JOS web site.

Version: 1.0

Author(s):
MichaelFried

*/
--MichaelFried
As in-source documentation should give the detailed description that can be extracted with javadoc/polardoc, I am for a one-line description in the first lines. Also, version information should go into META-INF/MANIFEST, see Java 1.2 Packaging specs. -- RalfStephan
I'm not a legal expert or anything, but doesn't an organization have to exist to hold copyright? --BillRehm



Content of these pages are owned and copyrighted by the poster.
Hosted by: