| 1 | <?xml version='1.0' encoding='UTF-8' standalone='no'?> |
|---|
| 2 | <doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.5.6"> |
|---|
| 3 | <compounddef id="codingrules" kind="page"> |
|---|
| 4 | <compoundname>codingrules</compoundname> |
|---|
| 5 | <title>Coding Rules (Mostly inherited from IT++)</title> |
|---|
| 6 | <detaileddescription> |
|---|
| 7 | <para>In the following sections we describe the naming conventions which are used for files, classes, structures, local variables, and global variables.</para><sect1 id="codingrules_1cr_variables"> |
|---|
| 8 | <title>Default Naming Rules for Variables</title> |
|---|
| 9 | <para>Variables are named using lower-case letters and words are separated using under-score. Abbreviations, when used in variable names, are also written with lower-case letters. Examples:</para><para><itemizedlist> |
|---|
| 10 | <listitem> |
|---|
| 11 | <para><computeroutput>`fft_size'</computeroutput> </para></listitem> |
|---|
| 12 | <listitem> |
|---|
| 13 | <para><computeroutput>`nrof_paths'</computeroutput> </para></listitem> |
|---|
| 14 | <listitem> |
|---|
| 15 | <para><computeroutput>`my_variable_name'</computeroutput> </para></listitem> |
|---|
| 16 | </itemizedlist> |
|---|
| 17 | </para><para>Some variable names or parts of variable names are commonly used in several different functions and files to denote the same thing. For instance the following common names and prefixes should be used:</para><para><itemizedlist> |
|---|
| 18 | <listitem> |
|---|
| 19 | <para><computeroutput>`rows'</computeroutput> - number of rows in a matrix </para></listitem> |
|---|
| 20 | <listitem> |
|---|
| 21 | <para><computeroutput>`cols'</computeroutput> - number of columns in a matrix </para></listitem> |
|---|
| 22 | <listitem> |
|---|
| 23 | <para><computeroutput>`nrof_'</computeroutput> - number of ... </para></listitem> |
|---|
| 24 | </itemizedlist> |
|---|
| 25 | </para></sect1> |
|---|
| 26 | <sect1 id="codingrules_1cr_files"> |
|---|
| 27 | <title>Default Naming Rules for Files</title> |
|---|
| 28 | <para>Files are named using lower-case letters and words are separated using under-score. Abbreviations, when used in file names, are also written with lower-case letters.</para><para>Source files are named using <computeroutput>`.cpp'</computeroutput> suffix, whereas header files end with <computeroutput>`.h'</computeroutput> extension. Examples:</para><para><itemizedlist> |
|---|
| 29 | <listitem> |
|---|
| 30 | <para><computeroutput>`my_file.h'</computeroutput> </para></listitem> |
|---|
| 31 | <listitem> |
|---|
| 32 | <para><computeroutput>`my_file.cpp'</computeroutput> </para></listitem> |
|---|
| 33 | </itemizedlist> |
|---|
| 34 | </para></sect1> |
|---|
| 35 | <sect1 id="codingrules_1cr_functions"> |
|---|
| 36 | <title>Default Naming Rules for Functions</title> |
|---|
| 37 | <para>Function names are named using lower-case letters and words are separated using under-score. Abbreviations, when used in function names, are also written with lower-case letters. This rule applies both to stand-alone functions as well as to member functions of classes. Example:</para><para><itemizedlist> |
|---|
| 38 | <listitem> |
|---|
| 39 | <para><computeroutput>int my_function_name(int a, int b)</computeroutput> </para></listitem> |
|---|
| 40 | </itemizedlist> |
|---|
| 41 | </para></sect1> |
|---|
| 42 | <sect1 id="codingrules_1cr_specialfunctions"> |
|---|
| 43 | <title>Convention for sensitive functions</title> |
|---|
| 44 | <para>For efficiency, some functions may return pointers to internal variables. Such functionality is indicated by underscore as the first letter in the the name.</para><para><itemizedlist> |
|---|
| 45 | <listitem> |
|---|
| 46 | <para><computeroutput>mat* _internal_matrix()</computeroutput> </para></listitem> |
|---|
| 47 | </itemizedlist> |
|---|
| 48 | </para></sect1> |
|---|
| 49 | <sect1 id="codingrules_1cr_classes"> |
|---|
| 50 | <title>Default Naming Rules for Classes and Structures</title> |
|---|
| 51 | <para>Each new word in a class or structure name should always start with a capital letter and the words should be separated with an under-score. Abbreviations are written with capital letters. Examples:</para><para><itemizedlist> |
|---|
| 52 | <listitem> |
|---|
| 53 | <para><computeroutput>`My_Class_Name'</computeroutput> </para></listitem> |
|---|
| 54 | <listitem> |
|---|
| 55 | <para><computeroutput>`My_Struct_Name'</computeroutput> </para></listitem> |
|---|
| 56 | <listitem> |
|---|
| 57 | <para><computeroutput>`OFDM'</computeroutput> </para></listitem> |
|---|
| 58 | </itemizedlist> |
|---|
| 59 | </para></sect1> |
|---|
| 60 | <sect1 id="codingrules_1cr_classes_functionality"> |
|---|
| 61 | <title>Default Functionality of Classes</title> |
|---|
| 62 | <para>All classes that are configured by input parameters should include:</para><para><itemizedlist> |
|---|
| 63 | <listitem> |
|---|
| 64 | <para>default empty constructor </para></listitem> |
|---|
| 65 | <listitem> |
|---|
| 66 | <para>one or more additional constructor(s) that takes input parameters and initializes the class instance </para></listitem> |
|---|
| 67 | <listitem> |
|---|
| 68 | <para>setup function, preferably named <computeroutput>`setup'</computeroutput> or <computeroutput>`set_parameters'</computeroutput> </para></listitem> |
|---|
| 69 | </itemizedlist> |
|---|
| 70 | </para><para>Explicit destructor functions are not required, unless they are needed. It shall not be possible to use any of the other member functions unless the class has been properly initiated with the input parameters. </para></sect1> |
|---|
| 71 | </detaileddescription> |
|---|
| 72 | </compounddef> |
|---|
| 73 | </doxygen> |
|---|
