I’m looking to create an IT Source Code policy. We have 3 international offices with one of our branches (dev team) has the source code at their site. We would like a source code policy to bring our source code with all the related issues (how/where, security aspect, etc.) to our head office. Do you have a such as policy?
[ad]
You might want to take a look at The Elements of Java Style.
The book is organized into 6 major sections:
1. General Principles. While it is important to write software that performs well, many other issues should concern the professional Java developer. All good software performs well. But great software, written with style, is predictable, robust, maintainable, supportable, and extensible. This section presents fundamental principles and practices for writing high-quality code, principles and practices that are built upon through the rest of the book.
2. Formatting Conventions. This section describes approaches to formatting your code to make it more readable, such as indenting (paragraphing) rules, the proper use of white space, and how to effectively break up long lines. Simple practices that have a big payoff when used consistently.
3. Naming Conventions. This section presents the standard Java naming conventions for classes, member functions, fields, getter and setter operations, local variables, parameters to member functions, and more. Many development teams waste hours, if not days, arguing about how to name the various aspects of their code. Do you really want to spend your time doing this, or spend it writing code? We’ve documented the standard naming conventions right here so that you don’t have to.
4. Documentation Conventions. Few programs are so simple, so trivial, that they don’t need to be documented. In this section we present a collection of principles and guidelines for writing effective source code documentation.
5. Programming Conventions. This section presents a collection of tips, techniques, and programming idioms for writing superior Java code. Techniques for improving the performance and efficiency of your code are presented, as well as conventions to improve the readability and quality of your code.
6. Packaging Conventions. The section presents a collection of packaging conventions for distributing your Java code.
Visit: http://www.ambysoft.com/essays/javaCodingStandards.html[ad]
Need help with your web writing? Click here for a Free Quote
Comments on this entry are closed.