| ramverma | af74a62 | 2018-07-31 18:25:39 +0100 | [diff] [blame^] | 1 | // |
| 2 | // ============LICENSE_START======================================================= |
| 3 | // Copyright (C) 2016-2018 Ericsson. All rights reserved. |
| 4 | // ================================================================================ |
| 5 | // This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE |
| 6 | // Full license text at https://creativecommons.org/licenses/by/4.0/legalcode |
| 7 | // |
| 8 | // SPDX-License-Identifier: CC-BY-4.0 |
| 9 | // ============LICENSE_END========================================================= |
| 10 | // |
| 11 | // @author Sven van der Meer (sven.van.der.meer@ericsson.com) |
| 12 | // |
| 13 | |
| 14 | == Introduction: APEX Codestyle |
| 15 | |
| 16 | This page describes how to apply a code style to the APEX Java projects. |
| 17 | The provided code templates are guidelines and are provided for references and as examples. |
| 18 | We will not engage in "holy war" on style for coding. |
| 19 | As long as the style of a particular block of code is understandable, consistent, and readable, please feel free to adapt or modify these guides or use other guides as you see fit. |
| 20 | |
| 21 | The JAutoDoc and Checkstyle Eclipse Plugins and tools are useful and remove a lot of the tedium from code documentation. |
| 22 | Use them to check your code and please fix any issues they identify with your code. |
| 23 | |
| 24 | The templates and examples on this page have been tested on a clean installation of Eclipse Oxygen Release (4.7.0) on Ubuntu Linux 16.04 LTS. |
| 25 | |
| 26 | The Apex settings referred to on this page are also available in the apex-model GIT repository in the APEX model repository in apex-model/apex-model.build-tools/src/main/resources/`. |
| 27 | |