Code Standard andQualityThe purpose ofmaintain code standard and quality is to maintain a set consistency and ensurethat the readability, scalability and performance is done to a high standard,to meet customer requirements. High code quality is a necessary as it will beeasy to reuse because it will focus on strong cohesion (single task orientated,ie a class has few responsibilities) and loose coupling (class independence).As an end result, quality code saves time and effort, and makes the producedsoftware effective and valuable to the user.Documentation in code the general formatting of the java documentation for will bedescripted for multi-line comments and for single -line comments.- Where in which instances should thedocumentation Documentation in the code should beimplemented at every instance that a new public or private class is declared,and must describe the overall purpose/ behaviour of the class or method.- Documented a method- Documented a class Descriptive names- Variable names should be short and meaningful ingeneral; however, the following points should describe the naming that shouldbe adopted – Class Names should be noun/pharses that will beeasy to be read and understand when going through code reviews and testing.
o Class names should be written like the exampleshown here: ‘ProductView’ – Method Names will be typically verbs phrasessuch as for example: ‘getMessage’ – Static final fields- Parameter NameOne character parameter names should beavoided at all costs to provide meaningful names which will be easy to readwhen testing and code reviews are being revised.- Local Variable names- should be written like inthe following example ‘paramterOne’ DRY removingduplication in the code will help in isolating change and will help inisolating risks that are being developed in the system. Should be adopted whendoing unit testing. IndentationIndentationwill be 2 spaces and there will be minimal to no trailing white spaces Outcomesof Quality check The resulting quality code will be easy to read andunderstand. It must be maintained easily and consistently. It must withstandany kind of input without breaking or behaving strangely, and must be welltested.
The design and the architecture must be simple. Documentation should beat a good level, so that during effective changes can be make. Formattingshould be adequately chosen and applied consistently throughout the wholeproject. At all levels (modules, classes, methods) there should be astrong relation and a high focus of the responsibilities (strong cohesion) –that means, a piece of code should focus on a particular task and shouldn’tdigress.
Functional independence/ (loose coupling) between modules,classes and methods is will be looked at as this is of importance, as it willeasier to test and issues will be one area that in all areas of code. Suitableand consistent naming of all program identifiers is a must. Documentationshould be embedded in the code itself.
