Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > comp.lang.java.programmer > #21836 > unrolled thread

Reading Code Standard

Back to article view | Back to comp.lang.java.programmer

Contents

  Reading Code Standard subhabangalore@gmail.com - 2013-01-29 08:29 -0800
    Re: Reading Code Standard Mikhail Vladimirov <vladimirow@mail.ru> - 2013-01-29 09:18 -0800
    Re: Reading Code Standard Martin Gregorie <martin@address-in-sig.invalid> - 2013-01-29 20:23 +0000
      Re: Reading Code Standard Lew <lewbloch@gmail.com> - 2013-01-29 13:14 -0800
    Re: Reading Code Standard Arne Vajhøj <arne@vajhoej.dk> - 2013-01-29 17:55 -0500

#21836 — Reading Code Standard

Dear Group,

The suggestions and the solutions given by the learned members of the group are very nice. Thank you for your kind time. 

Now as a new learner of the language, I am trying to consolidate my learning.

I want to read about good coding standards, and read some good codes in its various aspects. 

I was trying to search there are quite a few. But if you can kindly suggest.

Thanking You in Advance,

Regards,
Subhabrata.

[toc] | [next] | [standalone]

#21837

Maybe official conventions from Oracle is a good starting point: http://www.oracle.com/technetwork/java/codeconv-138413.html

[toc] | [prev] | [next] | [standalone]

#21841

On Tue, 29 Jan 2013 08:29:39 -0800, subhabangalore wrote:

> Dear Group,
> 
> The suggestions and the solutions given by the learned members of the
> group are very nice. Thank you for your kind time.
> 
> Now as a new learner of the language, I am trying to consolidate my
> learning.
> 
> I want to read about good coding standards, and read some good codes in
> its various aspects.
>
I think "The Practice of Programming" by Brian Kernighan and Rob Pike is 
well worth having. It describes good approached to naming, program layout 
and writing programs so they are easier to debug and maintain. There's 
not a lot about Java in it (its main focus is on C) but what it says is 
generally applicable to block structured languages: it gives examples in 
C, C++, Java, and Perl but its suggestions would be equally applicable to 
Python and Pascal.


-- 
martin@   | Martin Gregorie
gregorie. | Essex, UK
org       |

[toc] | [prev] | [next] | [standalone]

#21842

Martin Gregorie wrote:
> subhabangalore wrote:
>> The suggestions and the solutions given by the learned members of the
>> group are very nice. Thank you for your kind time.
> 
>> Now as a new learner of the language, I am trying to consolidate my
>> learning.
> 
>> I want to read about good coding standards, and read some good codes in
>> its various aspects.
> 
> I think "The Practice of Programming" by Brian Kernighan and Rob Pike is 
> well worth having. It describes good approached to naming, program layout 
> and writing programs so they are easier to debug and maintain. There's 
> not a lot about Java in it (its main focus is on C) but what it says is 
> generally applicable to block structured languages: it gives examples in 
> C, C++, Java, and Perl but its suggestions would be equally applicable to 
> Python and Pascal.

As mentioned upthread, there are standards specific to Java.

They boil down to:
- Use camel case for identifiers except constant variables.
- Start variable and method names (except constant variables) with a lower-case letter.
- Start type names with an upper-case letter.
- Constant variables are spelled with all upper case, with word parts separated by underscores.
- Do not use underscores for any other identifiers, and do not use the dollar sign "$" in identifiers.
- Indent four spaces (or two) per indent level. DO NOT USE TAB CHARACTERS TO INDENT.
- Enclose all sub-statements (conditional blocks, loop blocks, initializers, ...) in braces.
- Use either K&R brace placement or put the opening brace on its own line aligned with the 
   control line. (The second approach is unofficial but widely used.)
- Declare static variables (constants first), then static methods, then instance variables, then 
   instance methods within a type. (Reasonable deviations exist.)
- Use fully descriptive variable names. (Avoid shorthand like 'int s = ...'.)
- Javadoc all elements accessible outside the type.
- Names should reflect algorithmic purpose, not data type.

There's more, but that'll get you started.

-- 
Lew

[toc] | [prev] | [next] | [standalone]

#21843

On 1/29/2013 11:29 AM, subhabangalore@gmail.com wrote:
> The suggestions and the solutions given by the learned members of the group are very nice. Thank you for your kind time.
>
> Now as a new learner of the language, I am trying to consolidate my learning.
>
> I want to read about good coding standards, and read some good codes in its various aspects.
>
> I was trying to search there are quite a few. But if you can kindly suggest.

For a specific coding convention for Java go for the SUN (now Oracle)
Java Coding Convention.

For the reason behind using a coding convention go for a book
like Code Complete.

Arne

[toc] | [prev] | [standalone]

Back to top | Article view | comp.lang.java.programmer

csiph-web