[
https://issues.apache.org/jira/browse/MNEMONIC-10?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15230258#comment-15230258
]
Kai Zheng commented on MNEMONIC-10:
-----------------------------------
So in summary, the coding style would be as follows. Please help clarify if
necessary.
* Follows [Sun's code
conventions|http://www.oracle.com/technetwork/java/javase/documentation/codeconvtoc-136057.html]
* Use 2 spaces indentation, not 4, no tab.
* Line width is 120 chars.
* Public interface, class, methods and variables should have Javadoc.
The used IDE can be configured with the settings, and the existing source files
can be formatted either in batch or one by one, and committed as the initial
fixup. After that, checking style can be added as a building step enforced by
default. Then from now on, before each commit, the building should be run and
passed to ensure no break of this style.
> Define coding guidelines for the project
> ----------------------------------------
>
> Key: MNEMONIC-10
> URL: https://issues.apache.org/jira/browse/MNEMONIC-10
> Project: Mnemonic
> Issue Type: Task
> Reporter: Uma Maheswara Rao G
>
> This is the JIRA to discuss about the coding guideline for the project.
> 1) Identify the coding formatter rules for following across the project.
> 2) Under this JIRA, shall we reformat the whole code according to identified
> formatter ?
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
