[
http://issues.apache.org/jira/browse/DIRMINA-198?page=comments#action_12372864
]
Emmanuel Lecharny commented on DIRMINA-198:
-------------------------------------------
As far as I know, there is a naming convention used for MINA and ADS project.
Ok, it's not written somewhere on the site or in the wiki, too bad :)
So here are the common rules :
- CAPITAL_LETTERS for constants
- java naming convention for names. No m_, no prefix. They are useless. If the
method is long, and if you feel that you may confuse two variables, then split
your method in two. Hungarian notation was used in a context where you didn't
had any graphic IDE...
- a space after (, and before ) like :
if ( value == 1 )
- { and } are on the same column :
if ( value == 1 )
{
// code
}
- No tabs, 4 spaces.
- in general, use spaces around signs like =.
If you browse the code base, you will see that they are some places where those
rules are violated, but generally speaking, these are the rule we are now
trying to follow.
Of course, they are just like any other rules : if you break them, they won't
yell :)
> Naming conventions
> ------------------
>
> Key: DIRMINA-198
> URL: http://issues.apache.org/jira/browse/DIRMINA-198
> Project: Directory MINA
> Type: Wish
> Versions: 0.9.3
> Reporter: Michael Bauroth
> Priority: Trivial
>
> It would be a great idea to define some naming conventions for the source
> code. Especially for new users, but also for all others it can be confusing
> to know, if a special variable in a longer method is static or global or
> anything else. Naming conventions can generate more readable code and a
> quicker programming progress.
> In our company we use the following conventions:
> static final variables: UPPER_CASE
> static variables: sStatic (leading -s, next letter big)
> global variables: mMember (leading -m, next letter big)
> local (temporary) variables: tTemp (leading -t, next letter big)
> parameters: pParam (leading -p, next letter big)
> What do you think?
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
http://www.atlassian.com/software/jira
