Coding Standard

This document describes the coding standards for programming languages used by Cask projects. 

• Coding Standard

  • All the standards have been translated into an IntelliJ settings file to be used when developing code.

    • CDAP 6.9+: See this Medium article for the detailed description. Style XML can be found in this repository 

    • CDAP 6.8 and before:

      • Download an IntelliJ standard settings file:

        •  (IntelliJ IDEA CE 2016)

        •  (IntelliJ IDEA 13.1.1)

        •  (IntelliJ IDEA 12.0.2)

        •  (IntelliJ IDEA 11.x)

    • After you have downloaded the settings jar (yes, IntelliJ exports settings as JAR files), select File → Manage IDE Settings → Import Setting to apply the settings to your IDE.
      
      

    • On Select Components to Import prompt, click OK (all components must be imported).

    • Restart on prompt to import settings.

• Javadoc Coding Standards

  • Official Oracle Javadoc Style Guide

  • A helpful reference for writing Javadocs is the Liferay Javadoc Guidelines.