Skip to main content
Jump to: navigation, search

Difference between revisions of "IAM Development Conventions"

 
Line 1: Line 1:
{{backlink|IAM Environment}}
+
{{backlink|IAM Environment}}  
  
= IAM Development Conventions =
+
= IAM Development Conventions =
  
== Code formatting ==
+
== Code formatting ==
IAM inherits the Maven Coding Conventions. Eclipse settings can be [http://maven.apache.org/developers/maven-eclipse-codestyle.xml downloaded here] and imported by going to the ''Preferences > Java > Code Style > Formatter'' and then using the ''Import...'' button.
+
  
== File headers ==
+
IAM inherits the Maven Coding Conventions. Eclipse settings can be [http://maven.apache.org/developers/maven-eclipse-codestyle.xml downloaded here] and imported by going to the ''Preferences > Java > Code Style > Formatter'' and then using the ''Import...'' button.
These are the standard headers for new files:
+
  
=== Java ===
+
== File headers  ==
  
 +
These are the standard headers for new files:
 +
 +
=== Java  ===
  
 
  /*
 
  /*
Line 20: Line 21:
 
   */
 
   */
  
 +
<br> You can set this as the default for new files in ''Preferences &gt; Java &gt; Code Style &gt; Code Templates'' and then choose the ''Comments &gt; File'' node on the tree. Use the ''Edit...'' button to paste the comment.
  
You can set this as the default for new files in ''Preferences > Java > Code Style > Code Templates'' and then choose the ''Comments > File'' node on the tree. Use the ''Edit...'' button to paste the comment.
+
=== plugin.properties  ===
  
=== plugin.properties ===
 
 
  #-------------------------------------------------------------------------------
 
  #-------------------------------------------------------------------------------
 
  # Copyright (c) 2009 Exist Global, Inc. and others
 
  # Copyright (c) 2009 Exist Global, Inc. and others
Line 32: Line 33:
 
  #-------------------------------------------------------------------------------
 
  #-------------------------------------------------------------------------------
  
=== feature.properties ===
+
=== feature.properties ===
 +
 
 
  # "copyright" property - text of the "Feature Update Copyright"
 
  # "copyright" property - text of the "Feature Update Copyright"
 
  copyright=\
 
  copyright=\
Line 41: Line 43:
 
  http://www.eclipse.org/legal/epl-v10.html\n\
 
  http://www.eclipse.org/legal/epl-v10.html\n\
  
 +
== Subversion  ==
 +
 +
=== auto-props  ===
 +
 +
Set in $HOME/.subversion/config
 +
<pre>enable-auto-props = yes
 +
</pre>
 +
and the following auto-props
 +
<pre>[auto-props]
 +
 +
###The format of the entries is:
 +
###file-name-pattern = propname[=value][;propname[=value]...]
 +
###The file-name-pattern can contain wildcards (such as '*' and
 +
###'?'). All entries which match (case-insensitively) will be
 +
###applied to the file. Note that auto-props functionality
 +
###must be enabled, which is typically done by setting the
 +
###'enable-auto-props' option.
 +
 +
INSTALL = svn:eol-style=native;svn:keywords=Author Date Id Revision KEYS = svn:eol-style=native;svn:keywords=Author Date Id Revision Makefile = svn:eol-style=native;svn:keywords=Author Date Id Revision README = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
 +
*.aart = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.ac = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.aj = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.am = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.apt = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.bat = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.bsh = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.c = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.cat = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.cgi = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.classpath = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.cmd = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.cpp = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.css = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.cs = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.cwiki = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.data = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.dcl = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.doc = svn:mime-type=application/msword
 +
*.dsp = svn:eol-style=CRLF
 +
*.dsw = svn:eol-style=CRLF
 +
*.dtd = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.egrm = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.ent = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.ft = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.fml = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.fn = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.fv = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.grm = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.g = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.groovy = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.h = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
 +
.htaccess = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
 +
*.html = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.ico = svn:mime-type=image/x-icon
 +
*.ihtml = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.in = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.java = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.jpg = svn:mime-type=image/jpeg
 +
*.jsp = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.js = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.junit = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.m4 = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.mdo = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.mod = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.pdf = svn:mime-type=application/pdf
 +
*.pen = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.pl = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.png = svn:mime-type=image/png
 +
*.pod = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.pom = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.project = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.properties = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.py = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.rb = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.rdf = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.resx = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.rnc = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.rng = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.rnx = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.rss = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.sh = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.svg = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.tld = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.txt = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.types = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.vm = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.xcat = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.xconf = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.xdoc = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.xegrm = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.xgrm = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.xlex = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.xmap = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.xml = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.xsd = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.xsl = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.xslt = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.xsp = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
*.xul = svn:eol-style=native;svn:keywords=Author Date Id Revision
 +
</pre>
 
[[Category:IAM]]
 
[[Category:IAM]]

Latest revision as of 11:38, 30 August 2010

< To: IAM Environment

IAM Development Conventions

Code formatting

IAM inherits the Maven Coding Conventions. Eclipse settings can be downloaded here and imported by going to the Preferences > Java > Code Style > Formatter and then using the Import... button.

File headers

These are the standard headers for new files:

Java

/*
 * Copyright (c) 2009 Exist Global, Inc. and others
 * 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
 */


You can set this as the default for new files in Preferences > Java > Code Style > Code Templates and then choose the Comments > File node on the tree. Use the Edit... button to paste the comment.

plugin.properties

#-------------------------------------------------------------------------------
# Copyright (c) 2009 Exist Global, Inc. and others
# 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
#-------------------------------------------------------------------------------

feature.properties

# "copyright" property - text of the "Feature Update Copyright"
copyright=\
Copyright (c) 2009 Exist, Inc. and others\n\
All rights reserved. This program and the accompanying materials\n\
are made available under the terms of the Eclipse Public License v1.0\n\ 
which accompanies this distribution, and is available at\n\
http://www.eclipse.org/legal/epl-v10.html\n\

Subversion

auto-props

Set in $HOME/.subversion/config

enable-auto-props = yes

and the following auto-props

[auto-props] 

###The format of the entries is: 
###file-name-pattern = propname[=value][;propname[=value]...] 
###The file-name-pattern can contain wildcards (such as '*' and 
###'?'). All entries which match (case-insensitively) will be 
###applied to the file. Note that auto-props functionality 
###must be enabled, which is typically done by setting the 
###'enable-auto-props' option.

INSTALL = svn:eol-style=native;svn:keywords=Author Date Id Revision KEYS = svn:eol-style=native;svn:keywords=Author Date Id Revision Makefile = svn:eol-style=native;svn:keywords=Author Date Id Revision README = svn:eol-style=native;svn:keywords=Author Date Id Revision 

*.aart = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.ac = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.aj = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.am = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.apt = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.bat = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.bsh = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.c = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.cat = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.cgi = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.classpath = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.cmd = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.cpp = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.css = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.cs = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.cwiki = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.data = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.dcl = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.doc = svn:mime-type=application/msword 
*.dsp = svn:eol-style=CRLF 
*.dsw = svn:eol-style=CRLF 
*.dtd = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.egrm = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.ent = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.ft = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.fml = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.fn = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.fv = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.grm = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.g = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.groovy = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.h = svn:eol-style=native;svn:keywords=Author Date Id Revision

.htaccess = svn:eol-style=native;svn:keywords=Author Date Id Revision 

*.html = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.ico = svn:mime-type=image/x-icon 
*.ihtml = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.in = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.java = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.jpg = svn:mime-type=image/jpeg 
*.jsp = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.js = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.junit = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.m4 = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.mdo = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.mod = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.pdf = svn:mime-type=application/pdf 
*.pen = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.pl = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.png = svn:mime-type=image/png 
*.pod = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.pom = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.project = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.properties = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.py = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.rb = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.rdf = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.resx = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.rnc = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.rng = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.rnx = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.rss = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.sh = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.svg = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.tld = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.txt = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.types = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.vm = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.xcat = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.xconf = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.xdoc = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.xegrm = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.xgrm = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.xlex = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.xmap = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.xml = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.xsd = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.xsl = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.xslt = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.xsp = svn:eol-style=native;svn:keywords=Author Date Id Revision 
*.xul = svn:eol-style=native;svn:keywords=Author Date Id Revision

Back to the top