कोड स्टाइल गाइड

संग्रह की मदद से व्यवस्थित रहें अपनी प्राथमिकताओं के आधार पर, कॉन्टेंट को सेव करें और कैटगरी में बांटें.

HIDL कोड स्टाइल, Android फ़्रेमवर्क में C++ कोड से मिलता-जुलता है. इसमें चार स्पेस के साथ इंडेंट और अलग-अलग केस वाले फ़ाइल नाम होते हैं. पैकेज के एलान, इंपोर्ट, और दस्तावेज़ के ब्यौरे, Java में मौजूद इन चीज़ों से मिलते-जुलते हैं. हालांकि, इनमें कुछ बदलाव किए गए हैं.

IFoo.hal और types.hal के लिए दिए गए उदाहरणों में, HIDL कोड स्टाइल के बारे में बताया गया है. साथ ही, हर स्टाइल के बारे में जानकारी के लिए, लिंक भी दिए गए हैं. IFooClientCallback.hal, IBar.hal, और IBaz.hal को शामिल नहीं किया गया है.

/*
 * (License Notice)
 */

package android.hardware.foo@1.0;

import android.hardware.bar@1.0::IBar;

import IBaz;
import IFooClientCallback;

/**
 * IFoo is an interface that…
 */
interface IFoo {

    /**
     * This is a multiline docstring.
     *
     * @return result 0 if successful, nonzero otherwise.
     */
     foo() generates (FooStatus result);

    /**
     * Restart controller by power cycle.
     *
     * @param bar callback interface that…
     * @return result 0 if successful, nonzero otherwise.
     */
    powerCycle(IBar bar) generates (FooStatus result);

    /** Single line docstring. */
    baz();


    /**
     * The bar function.
     *
     * @param clientCallback callback after function is called
     * @param baz related baz object
     * @param data input data blob
     */
    bar(IFooClientCallback clientCallback,
        IBaz baz,
        FooData data);

};

/*
 * (License Notice)
 */

package android.hardware.foo@1.0;

/** Replied status. */
enum Status : int32_t {
    OK,
    /* invalid arguments */
    ERR_ARG,
    /* note, no transport related errors */
    ERR_UNKNOWN = -1,
};

struct ArgData {
    int32_t[20]  someArray;
    vec<uint8_t> data;
};

नेमिंग कन्वेंशन

फ़ंक्शन के नाम, वैरिएबल के नाम, और फ़ाइल के नाम ऐसे होने चाहिए जिनसे उनके बारे में जानकारी मिलती हो. नामों को बहुत छोटा न करें. छोटे शब्दों को शब्दों के तौर पर इस्तेमाल करें. उदाहरण के लिए, INFC के बजाय INfc का इस्तेमाल करें.

डायरेक्ट्री का स्ट्रक्चर और फ़ाइल को नाम देना

डायरेक्ट्री का स्ट्रक्चर इस तरह दिखना चाहिए:

• ROOT-DIRECTORY
  • MODULE
    • SUBMODULE (ज़रूरी नहीं, एक से ज़्यादा लेवल हो सकते हैं)
      • VERSION
        • Android.mk
        • IINTERFACE_1.hal
        • IINTERFACE_2.hal
        • …
        • IINTERFACE_N.hal
        • types.hal (वैकल्पिक)

कहाँ:

• ROOT-DIRECTORY है:
  • hardware/interfaces के लिए मुख्य HIDL पैकेज.
  • वेंडर पैकेज के लिए vendor/VENDOR/interfaces, जहां VENDOR का मतलब SoC वेंडर या OEM/ODM से है.
• MODULE एक छोटा शब्द होना चाहिए, जो सबसिस्टम के बारे में बताता हो (उदाहरण के लिए, nfc). अगर एक से ज़्यादा शब्दों की ज़रूरत है, तो नेस्ट किए गए SUBMODULE का इस्तेमाल करें. नेस्ट करने के एक से ज़्यादा लेवल हो सकते हैं.
• VERSION का वर्शन (major.minor) वही होना चाहिए जो वर्शन में बताया गया है.
• IINTERFACE_X, इंटरफ़ेस के नाम में बताए गए UpperCamelCase/PascalCase (उदाहरण के लिए, INfc) के साथ इंटरफ़ेस का नाम होना चाहिए.

उदाहरण:

• hardware/interfaces
  • nfc
    • 1.0
      • Android.mk
      • INfc.hal
      • INfcClientCallback.hal
      • types.hal

ध्यान दें: सभी फ़ाइलों के लिए, Git में ऐसी अनुमतियां होनी चाहिए जिनसे उन्हें चलाया न जा सके.

पैकेज के नाम

पैकेज के नामों में, पूरी तरह क्वालिफ़ाइड नेम (एफ़क्यूएन) फ़ॉर्मैट का इस्तेमाल करना ज़रूरी है. इसे PACKAGE-NAME कहा जाता है:

PACKAGE.MODULE[.SUBMODULE[.SUBMODULE[…]]]@VERSION

कहाँ:

• PACKAGE वह पैकेज है जो ROOT-DIRECTORY पर मैप करता है. खास तौर पर, PACKAGE:
  • मुख्य HIDL पैकेज के लिए android.hardware (hardware/interfaces पर मैप किया गया).
  • वेंडर पैकेज के लिए vendor.VENDOR.hardware, जहां VENDOR से SoC वेंडर या OEM/ODM (vendor/VENDOR/interfaces पर मैप करने वाला) का पता चलता है.
• MODULE[.SUBMODULE[.SUBMODULE[…]]]@VERSION डायरेक्ट्री स्ट्रक्चर में बताए गए स्ट्रक्चर में, फ़ोल्डर के नाम एक जैसे हों.
• पैकेज के नाम छोटे अक्षरों में होने चाहिए. अगर वे एक से ज़्यादा शब्दों के हैं, तो उन शब्दों को सब-मोड्यूल के तौर पर इस्तेमाल किया जाना चाहिए या snake_case में लिखा जाना चाहिए.
• बीच में कोई स्पेस नहीं होना चाहिए.

पैकेज के एलान में हमेशा एफ़क्यूएन का इस्तेमाल किया जाता है.

वर्शन

वर्शन का फ़ॉर्मैट इस तरह होना चाहिए:

MAJOR.MINOR

MAJOR और MINOR, दोनों वर्शन एक ही पूर्णांक होने चाहिए. HIDL, सेमांटिक वर्शनिंग नियमों का इस्तेमाल करता है.

इंपोर्ट

इंपोर्ट इनमें से किसी एक फ़ॉर्मैट में होता है:

• पूरे पैकेज को इंपोर्ट करना: import PACKAGE-NAME;
• कुछ डेटा इंपोर्ट करना: import PACKAGE-NAME::UDT; (या, अगर इंपोर्ट किया गया टाइप एक ही पैकेज में है,import UDT;
• सिर्फ़ टाइप वाले इंपोर्ट: import PACKAGE-NAME::types;

PACKAGE-NAME, पैकेज के नाम में बताए गए फ़ॉर्मैट का पालन करता है. मौजूदा पैकेज का types.hal (अगर मौजूद है) अपने-आप इंपोर्ट हो जाता है. इसे साफ़ तौर पर इंपोर्ट न करें.

पूरी तरह क्वालिफ़ाइड नेम (एफ़क्यूएन)

उपयोगकर्ता के तय किए गए टाइप के इंपोर्ट के लिए, पूरी तरह क्वालिफ़ाइड नामों का इस्तेमाल सिर्फ़ तब करें, जब ज़रूरी हो. अगर इंपोर्ट टाइप एक ही पैकेज में है, तो PACKAGE-NAME को शामिल न करें. एफ़क्यूएन में स्पेस नहीं होने चाहिए. पूरी तरह क्वालिफ़ाइड नाम का उदाहरण:

android.hardware.nfc@1.0::INfcClientCallback

android.hardware.nfc@1.0 में मौजूद किसी दूसरी फ़ाइल में, ऊपर दिए गए इंटरफ़ेस को INfcClientCallback के तौर पर रेफ़र करें. इसके अलावा, सिर्फ़ पूरी तरह से सही नाम का इस्तेमाल करें.

इंपोर्ट को ग्रुप में बांटना और उनका क्रम तय करना

पैकेज के एलान के बाद (इंपोर्ट से पहले) खाली लाइन का इस्तेमाल करें. हर इंपोर्ट को एक लाइन में लिखा जाना चाहिए और उसे इंडेंट नहीं किया जाना चाहिए. इंपोर्ट को इस क्रम में ग्रुप करें:

1. अन्य android.hardware पैकेज (पूरी तरह से क्वालिफ़ाइड नामों का इस्तेमाल करें).
2. अन्य vendor.VENDOR पैकेज (पूरी तरह से क्वालिफ़ाइड नामों का इस्तेमाल करें).
   • हर वेंडर एक ग्रुप होना चाहिए.
   • वेंडर को वर्णमाला के क्रम में लगाएं.
3. एक ही पैकेज के दूसरे इंटरफ़ेस से इंपोर्ट (सरल नामों का इस्तेमाल करें).

ग्रुप के बीच खाली लाइन का इस्तेमाल करें. हर ग्रुप में, इंपोर्ट को अंग्रेज़ी वर्णमाला के क्रम में क्रम से लगाएं. उदाहरण:

import android.hardware.nfc@1.0::INfc;
import android.hardware.nfc@1.0::INfcClientCallback;

/* Importing the whole module. */
import vendor.barvendor.bar@3.1;

import vendor.foovendor.foo@2.2::IFooBar;
import vendor.foovendor.foo@2.2::IFooFoo;

import IBar;
import IFoo;

इंटरफ़ेस के नाम

इंटरफ़ेस के नाम I से शुरू होने चाहिए. इसके बाद, UpperCamelCase/PascalCase नाम होना चाहिए. IFoo.hal फ़ाइल में, नाम IFoo वाला इंटरफ़ेस होना चाहिए. इस फ़ाइल में, सिर्फ़ IFoo इंटरफ़ेस की परिभाषाएं हो सकती हैं. इंटरफ़ेस INAME, INAME.hal में होना चाहिए.

फ़ंक्शन

फ़ंक्शन के नाम, आर्ग्युमेंट, और रिटर्न वैरिएबल के नाम के लिए, lowerCamelCase का इस्तेमाल करें. उदाहरण:

open(INfcClientCallback clientCallback) generates (int32_t retVal);
oneway pingAlive(IFooCallback cb);

स्ट्रक्चर और यूनियन फ़ील्ड के नाम

स्ट्रक्चर या यूनियन फ़ील्ड के नामों के लिए, lowerCamelCase का इस्तेमाल करें. उदाहरण:

struct FooReply {
    vec<uint8_t> replyData;
}

नाम टाइप करना

टाइप के नामों से, स्ट्रक्चर या यूनियन की परिभाषाओं, सूची के टाइप की परिभाषाओं, और typedef के बारे में पता चलता है. इन नामों के लिए, UpperCamelCase/PascalCase का इस्तेमाल करें. उदाहरण:

enum NfcStatus : int32_t {
    /*...*/
};
struct NfcData {
    /*...*/
};

Enum वैल्यू

वैल्यू UPPER_CASE_WITH_UNDERSCORES होनी चाहिए. किसी फ़ंक्शन के आर्ग्युमेंट के तौर पर वैल्यू पास करते समय और उन्हें फ़ंक्शन के तौर पर रिटर्न करते समय, असल वैल्यू का इस्तेमाल करें, न कि अंकों वाले वैल्यू के टाइप का. उदाहरण:

enum NfcStatus : int32_t {
    HAL_NFC_STATUS_OK               = 0,
    HAL_NFC_STATUS_FAILED           = 1,
    HAL_NFC_STATUS_ERR_TRANSPORT    = 2,
    HAL_NFC_STATUS_ERR_CMD_TIMEOUT  = 3,
    HAL_NFC_STATUS_REFUSED          = 4
};

ध्यान दें: कोलन के बाद, किसी एनम टाइप के बुनियादी टाइप को साफ़ तौर पर बताया जाता है. यह कंपाइलर पर निर्भर नहीं है, इसलिए असल वैल्यू के टाइप का इस्तेमाल करना ज़्यादा बेहतर होता है.

एनम वैल्यू के लिए पूरी तरह क्वालिफ़ाइड नामों के लिए, एनम टाइप के नाम और एनम वैल्यू के नाम के बीच कोलन का इस्तेमाल किया जाता है:

PACKAGE-NAME::UDT[.UDT[.UDT[…]]:ENUM_VALUE_NAME

पूरी तरह क्वालिफ़ाइड नेम में स्पेस नहीं होने चाहिए. ज़रूरत पड़ने पर ही पूरी तरह क्वालिफ़ाइड नेम का इस्तेमाल करें. साथ ही, ग़ैर-ज़रूरी हिस्सों को हटा दें. उदाहरण:

android.hardware.foo@1.0::IFoo.IFooInternal.FooEnum:ENUM_OK

टिप्पणियां

एक लाइन की टिप्पणी के लिए, //, /* */, और /** */ का इस्तेमाल किया जा सकता है.

// This is a single line comment
/* This is also single line comment */
/** This is documentation comment */

• टिप्पणियों के लिए /* */ का इस्तेमाल करें. HIDL, टिप्पणियों के लिए // का इस्तेमाल करता है. हालांकि, इसका सुझाव नहीं दिया जाता, क्योंकि ये जनरेट किए गए आउटपुट में नहीं दिखती हैं.
• जनरेट किए गए दस्तावेज़ के लिए, /** */ का इस्तेमाल करें. इन्हें सिर्फ़ टाइप, तरीके, फ़ील्ड, और एनम वैल्यू के एलान पर लागू किया जा सकता है. उदाहरण:

  /** Replied status */
  enum TeleportStatus {
      /** Object entirely teleported. */
      OK              = 0,
      /** Methods return this if teleportation is not completed. */
      ERROR_TELEPORT  = 1,
      /**
       * Teleportation could not be completed due to an object
       * obstructing the path.
       */
      ERROR_OBJECT    = 2,
      ...
  }

• एक से ज़्यादा लाइन वाली टिप्पणियां शुरू करने के लिए, अलग लाइन में /** लिखें. हर लाइन की शुरुआत में * का इस्तेमाल करें. टिप्पणी को अलग लाइन में */ के साथ खत्म करें. साथ ही, तारे को अलाइन करें. उदाहरण:

  /**
   * My multi-line
   * comment
   */

• लाइसेंस की सूचना और बदलावों की जानकारी देने वाली लाइन को /* (एक तारा) से शुरू करना चाहिए. साथ ही, हर लाइन की शुरुआत में * का इस्तेमाल करना चाहिए. आखिरी लाइन में */ अपने-आप दिखना चाहिए. तारे अलाइन होने चाहिए. उदाहरण:

  /*
   * Copyright (C) 2017 The Android Open Source Project
   * ...
   */
  
  /*
   * Changelog:
   * ...
   */

फ़ाइल पर की गई टिप्पणियां

हर फ़ाइल को लाइसेंस से जुड़ी सही सूचना के साथ शुरू करें. मुख्य एचएएल के लिए, यह development/docs/copyright-templates/c.txt में AOSP Apache लाइसेंस होना चाहिए. साल अपडेट करना न भूलें. साथ ही, ऊपर बताए गए तरीके के मुताबिक, /* */ स्टाइल की कई लाइन वाली टिप्पणियों का इस्तेमाल करें.

लाइसेंस की सूचना के बाद, एक खाली लाइन जोड़ी जा सकती है. इसके बाद, बदलावों की जानकारी/वर्शन की जानकारी दी जा सकती है. हालांकि, ऐसा करना ज़रूरी नहीं है. ऊपर बताए गए तरीके के मुताबिक, /* */ स्टाइल वाली कई लाइन वाली टिप्पणियों का इस्तेमाल करें. इसके बाद, बदलावों की सूची के बाद खाली लाइन डालें और फिर पैकेज के एलान के साथ जारी रखें.

TODO टिप्पणियां

'क्या-क्या करना है' सेक्शन में, TODO स्ट्रिंग को अंग्रेज़ी के बड़े अक्षरों में लिखा जाना चाहिए. इसके बाद, कोलन लगाना चाहिए. उदाहरण:

// TODO: remove this code before foo is checked in.

TODO टिप्पणियों की अनुमति सिर्फ़ डेवलपमेंट के दौरान होती है. इन्हें पब्लिश किए गए इंटरफ़ेस में नहीं होना चाहिए.

इंटरफ़ेस और फ़ंक्शन की टिप्पणियां (डॉस्ट्रिंग)

एक से ज़्यादा लाइन वाले और एक लाइन वाले दस्तावेज़ों के लिए, /** */ का इस्तेमाल करें. docstrings के लिए // का इस्तेमाल न करें.

इंटरफ़ेस के लिए दस्तावेज़ों में, इंटरफ़ेस के सामान्य तरीके, डिज़ाइन के मकसद, मकसद वगैरह के बारे में बताया जाना चाहिए. फ़ंक्शन के लिए दस्तावेज़, फ़ंक्शन के हिसाब से होने चाहिए. पैकेज-लेवल का दस्तावेज़, पैकेज डायरेक्ट्री में README फ़ाइल में जाता है.

/**
 * IFooController is the controller for foos.
 */
interface IFooController {
    /**
     * Opens the controller.
     *
     * @return status HAL_FOO_OK if successful.
     */
    open() generates (FooStatus status);

    /** Close the controller. */
    close();
};

आपको हर पैरामीटर/रिटर्न वैल्यू के लिए @param और @return जोड़ने होंगे:

• हर पैरामीटर के लिए @param जोड़ना ज़रूरी है. इसके बाद, पैरामीटर का नाम और फिर डोकस्ट्रिंग होनी चाहिए.
• हर रिटर्न वैल्यू के लिए, @return जोड़ना ज़रूरी है. इसके बाद, रिटर्न वैल्यू का नाम और फिर दस्तावेज़ का नाम होना चाहिए.

उदाहरण:

/**
 * Explain what foo does.
 *
 * @param arg1 explain what arg1 is
 * @param arg2 explain what arg2 is
 * @return ret1 explain what ret1 is
 * @return ret2 explain what ret2 is
 */
foo(T arg1, T arg2) generates (S ret1, S ret2);

फ़ॉर्मैटिंग के नियम

फ़ॉर्मैट करने के सामान्य नियमों में ये शामिल हैं:

• लाइन की लंबाई. टेक्स्ट की हर लाइन में ज़्यादा से ज़्यादा 100 कॉलम होने चाहिए.
• व्हाइटस्पेस. लाइनों के आखिर में कोई खाली जगह नहीं होनी चाहिए. खाली लाइनों में भी खाली जगह नहीं होनी चाहिए.
• स्पेसेज़ बनाम टैब. सिर्फ़ स्पेस का इस्तेमाल करें.
• इंडेंट का साइज़. ब्लॉक के लिए चार स्पेस और लाइन रैप के लिए आठ स्पेस का इस्तेमाल करें
• ब्रेज़िंग. एनोटेशन वैल्यू को छोड़कर, ओपन ब्रैकेट, पहले वाले कोड की उसी लाइन पर होता है. हालांकि, क्लोज़ ब्रैकेट और उसके बाद वाला सेमीकोलन पूरी लाइन पर होता है. उदाहरण:

  interface INfc {
      close();
  };

पैकेज के एलान की जानकारी

पैकेज का एलान, फ़ाइल में सबसे ऊपर होना चाहिए. यह एलान, लाइसेंस की सूचना के बाद होना चाहिए. यह एलान पूरी लाइन में होना चाहिए और इसमें इंडेंट नहीं होना चाहिए. पैकेज का नाम बताने के लिए, इस फ़ॉर्मैट का इस्तेमाल किया जाता है. नाम को फ़ॉर्मैट करने के लिए, पैकेज के नाम देखें:

package PACKAGE-NAME;

उदाहरण:

package android.hardware.nfc@1.0;

फ़ंक्शन के एलान

फ़ंक्शन का नाम, पैरामीटर, generates, और रिटर्न वैल्यू एक ही लाइन में होनी चाहिए. उदाहरण:

interface IFoo {
    /** ... */
    easyMethod(int32_t data) generates (int32_t result);
};

अगर ये एक ही लाइन में नहीं आते हैं, तो पैरामीटर और रिटर्न वैल्यू को एक ही इंडेंट लेवल में डालने की कोशिश करें. साथ ही, generate का इस्तेमाल करके, पैरामीटर और रिटर्न वैल्यू को अलग-अलग दिखाएं, ताकि पाठक को पैरामीटर और रिटर्न वैल्यू को तुरंत देखने में मदद मिल सके. उदाहरण:

interface IFoo {
    suchALongMethodThatCannotFitInOneLine(int32_t theFirstVeryLongParameter,
                                          int32_t anotherVeryLongParameter);
    anEvenLongerMethodThatCannotFitInOneLine(int32_t theFirstLongParameter,
                                             int32_t anotherVeryLongParameter)
                                  generates (int32_t theFirstReturnValue,
                                             int32_t anotherReturnValue);
    superSuperSuperSuperSuperSuperSuperLongMethodThatYouWillHateToType(
            int32_t theFirstVeryLongParameter, // 8 spaces
            int32_t anotherVeryLongParameter
        ) generates (
            int32_t theFirstReturnValue,
            int32_t anotherReturnValue
        );
    /* method name is even shorter than 'generates' */
    foobar(AReallyReallyLongType aReallyReallyLongParameter,
           AReallyReallyLongType anotherReallyReallyLongParameter)
        generates (ASuperLongType aSuperLongReturnValue, // 4 spaces
                   ASuperLongType anotherSuperLongReturnValue);
}

अतिरिक्त विवरण:

• ओपन ब्रैकेट हमेशा फ़ंक्शन के नाम वाली लाइन में होता है.
• फ़ंक्शन के नाम और ओपन ब्रैकेट के बीच कोई स्पेस नहीं होना चाहिए.
• ब्रैकेट और पैरामीटर के बीच कोई स्पेस नहीं होना चाहिए. हालांकि, अगर उनके बीच लाइन फ़ीड हैं, तो स्पेस हो सकते हैं.
• अगर generates, पिछले ब्रैकेट के साथ एक ही लाइन में है, तो उसके पहले स्पेस का इस्तेमाल करें. अगर generates, अगले ब्रैकेट के साथ एक ही पंक्ति में है, तो इसके बाद स्पेस दें.
• सभी पैरामीटर और रिटर्न वैल्यू को अलाइन करें (अगर हो सके).
• डिफ़ॉल्ट इंडेंटेशन चार स्पेस होता है.
• रैप किए गए पैरामीटर, पिछली लाइन के पहले पैरामीटर के साथ अलाइन होते हैं. ऐसा न होने पर, उनके लिए आठ स्पेस का इंडेंट होता है.

एनोटेशन

एनोटेशन के लिए, इस फ़ॉर्मैट का इस्तेमाल करें:

@annotate(keyword = value, keyword = {value, value, value})

एनोटेशन को वर्णमाला के क्रम में क्रम से लगाएं. साथ ही, बराबर के निशान के आस-पास स्पेस का इस्तेमाल करें. उदाहरण:

@callflow(key = value)
@entry
@exit

पक्का करें कि एनोटेशन पूरी लाइन में हो. उदाहरण:

/* Good */
@entry
@exit

/* Bad */
@entry @exit

अगर एनोटेशन एक ही लाइन में नहीं आते हैं, तो उन्हें आठ स्पेस के साथ इंडेंट करें. उदाहरण:

@annotate(
        keyword = value,
        keyword = {
                value,
                value
        },
        keyword = value)

अगर वैल्यू का पूरा कलेक्शन एक ही लाइन में नहीं आ पा रहा है, तो खोले गए ब्रैकेट { के बाद और कलेक्शन में मौजूद हर कॉमा के बाद लाइन ब्रेक लगाएं. आखिरी वैल्यू के तुरंत बाद, क्लोज़िंग ब्रैकेट डालें. अगर सिर्फ़ एक वैल्यू है, तो ब्रैकेट न डालें.

अगर पूरा वैल्यू कलेक्शन एक ही लाइन में फ़िट हो सकता है, तो ब्रैकेट खोलने के बाद और बंद करने से पहले स्पेस का इस्तेमाल न करें. साथ ही, हर कॉमा के बाद एक स्पेस का इस्तेमाल करें. उदाहरण:

/* Good */
@callflow(key = {"val", "val"})

/* Bad */
@callflow(key = { "val","val" })

एनोटेशन और फ़ंक्शन के एलान के बीच खाली लाइनें नहीं होनी चाहिए. उदाहरण:

/* Good */
@entry
foo();

/* Bad */
@entry

foo();

Enum एलान

एनम के एलान के लिए, इन नियमों का इस्तेमाल करें:

• अगर किसी दूसरे पैकेज के साथ एनम डिक्लेरेशन शेयर किए जाते हैं, तो डिक्लेरेशन को इंटरफ़ेस में एम्बेड करने के बजाय, types.hal में डालें.
• कोलन से पहले और बाद में स्पेस का इस्तेमाल करें. साथ ही, ब्रैकेट खोलने से पहले, डेटा टाइप के बाद स्पेस का इस्तेमाल करें.
• हो सकता है कि आखिरी एनम वैल्यू में अतिरिक्त कॉमा न हो.

स्ट्रक्चर के एलान

स्ट्रक्चर के एलान के लिए, इन नियमों का इस्तेमाल करें:

• अगर स्ट्रक्चर के एलान किसी दूसरे पैकेज के साथ शेयर किए जाते हैं, तो एलान को इंटरफ़ेस में एम्बेड करने के बजाय, types.hal में डालें.
• स्ट्रक्चर टाइप के नाम के बाद, ब्रैकेट खोलने से पहले स्पेस का इस्तेमाल करें.
• फ़ील्ड के नाम अलाइन करें (ज़रूरी नहीं). उदाहरण:

  struct MyStruct {
      vec<uint8_t>   data;
      int32_t        someInt;
  }

ऐरे एलान

इनके बीच स्पेस न डालें:

• एलिमेंट टाइप और ओपन स्क्वेयर ब्रैकेट.
• स्क्वेयर ब्रैकेट और ऐरे का साइज़ खोलें.
• ऐरे का साइज़ और स्क्वेयर ब्रैकेट बंद करने वाला चिह्न.
• स्क्वेयर ब्रैकेट बंद करें और अगला स्क्वेयर ब्रैकेट खोलें. ऐसा तब करें, जब एक से ज़्यादा डाइमेंशन मौजूद हों.

उदाहरण:

/* Good */
int32_t[5] array;

/* Good */
int32_t[5][6] multiDimArray;

/* Bad */
int32_t [ 5 ] [ 6 ] array;

वेक्टर

इनके बीच स्पेस न डालें:

• vec और ओपन ऐंगल ब्रैकेट.
• ओपन ऐंगल ब्रैकेट और एलिमेंट टाइप (अपवाद: एलिमेंट टाइप भी एक तरह का vec है).
• एलिमेंट टाइप और क्लोज़ ऐंगल ब्रैकेट (अपवाद: एलिमेंट टाइप भी एक तरह का vec है).

उदाहरण:

/* Good */
vec<int32_t> array;

/* Good */
vec<vec<int32_t>> array;

/* Good */
vec< vec<int32_t> > array;

/* Bad */
vec < int32_t > array;

/* Bad */
vec < vec < int32_t > > array;