Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Higgins/Template - File Headers

< Higgins
Revision as of 10:34, 14 June 2008 by Paul.socialphysics.org (Talk | contribs) (OWL Files)

{{#eclipseproject:technology.higgins}}

File Headers, Copyright

Java files

We follow the Eclipse conventions. Each Java file should have a header like this with "2005-2008" replaced with the correct year(s), "Parity Communications, Inc." replace with the copyright holder, and "Paul Trevithick" replaced with original author of the file:

/*******************************************************************************
* Copyright (c) 2005-2008 Parity Communications, Inc.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Paul Trevithick - initial API and implementation
*******************************************************************************/

OWL Files

Should carry a header like this

<!--
*******************************************************************************
* Copyright (c) 2008 <copyright holder>
* All rights reserved. This document and accompanying materials 
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html

* Contributors:
* <someone's name> - initial vocabulary
*******************************************************************************
-->

EMF-generated classes

In Higgins we order the methods in an EMF-generated class as follows:

  1. All @generated methods that have not been modified at all are listed first,
  2. followed by "////////////" (twelve forward slashes),
  3. followed by any non-generated methods, OR any "@generated NOT" methods.

This convention has evolved from bitter experience. There are times (now fairly rare) when EMF gets sufficiently confused with a series of complex changes to the model and to the code, that it is quicker to delete the entire generated class file and have it regenerated. Before deleting, we copy everything below the //////////// into a scratch file, and use it to patch up the freshly regenerated file later.

Back to the top