[ http://issues.apache.org/jira/browse/DIRMINA-198?page=comments#action_12372889 ]
Michael Bauroth commented on DIRMINA-198: ----------------------------------------- I agree with all above regarding the coding conventions. The readability of the code is even better then most other code I've seen before :) Some of the rules were new for me, but I've tried to use them in my last sample too. On the other hand I think, the use of prefixes in variables (without underscore) can help to improve the readability too. We can't assume that everyone uses a graphic IDE or syntax highlighting. Another case is the use of code dump in articles, mails ... there we haven't syntax highlighting too. When we use only small code samples out of the box without figuring out, of which type some variables are (or giving them some prefixes), the reader don't know what they are. But ok, it was only a wish :) > 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
