source: JEM-EUSO/esaf_lal/tags/v1_r0/esafdoc/DevelopersGuide/CodingConventions.tex @ 117

%------------------------------------------------------------------------------
\section{Introduction}
%------------------------------------------------------------------------------

This guide is miles away from to be complete and exhaustive. But \ESAF{} developers team is getting bigger and bigger and I hope that an even small reference guide dedicated to the developers may be useful to avoid painful debugging and long and sometimes ``hot'' mail exchanges.

This first version of this guide would like to cover several aspects related with the classes \ESAF{} is founded on.

%------------------------------------------------------------------------------
\section{Text formatting}
%------------------------------------------------------------------------------

Indentation: 4 spaces, no tabs.

%------------------------------------------------------------------------------
\subsection{Configuring VIM}
%------------------------------------------------------------------------------

Add to your \code{~/.vimrc} the following lines:

\begin{displaycode}
set shiftwidth=4
set softtabstop=4
set tabstop=4
set expandtab
\end{displaycode}

to tell VIm to use the correct indentation.

%------------------------------------------------------------------------------
\subsection{Configuring Emacs}
%------------------------------------------------------------------------------
Add to your \code{~/.emacsrc} the following line:

\begin{displaycode}
(setq c-basic-offset 4)
\end{displaycode}


%------------------------------------------------------------------------------
\section{Coding Conventions}
%------------------------------------------------------------------------------

\ESAF{} follows \ROOT{}/Taligent name convention. Due to historical reasons there some exceptions exists.
Class names don't begin with a T and a restricted number of them begins with E.

The following paragraph is part of Addison-Wesley's \textsl{Taligent Guide} \cite{bib:taligent}.

\begin{quote}
Select C++ identifiers (including types, functions, and classes) carefully. When a programmer sees a name, it might be out of context; choose names to enhance readability and comprehension. A name that seems cute or easy to type can cause trouble to someone trying to decipher code. Remember, code is read many more times than it is written; err on the side of long, readable names. Internal code names should not appear anywhere in the interfaces to the system. Even inside your implementation, it's better to use the prosaic form if there is one.


To make the scope of names explicit, Taligent uses the conventions of table \ref{tab:conv}.

In any name that contains more than one word, the first word follows the convention for the type of the name, and subsequent words follow with the first letter of each word capitalized, such as TTextBase. Do not use underscores except for \code{\#define} symbols.
\end{quote}

\begin{table*}[ht!]
        \centering\footnotesize
                \begin{tabular}{|l>{\raggedright}p{140pt}l|}
                \hline &&\\[-2mm]
                        \textbf{\small Identifier}& \textbf{\small Convention}              & \textbf{\small Example}\\[5mm]
                                Types                   & Begin with a capital letter             & Boolean \\
%                               Base classes            & Begin with T                            & TContainerView\\
%             Mixin classes             & Begin with M                            & \\
%see "Multiple inheritance" on page 44  MPrintable
        Enumeration types       & Begin with E                            & EFreezeLevel\\
        %Raw C types    Avoid using C types; see "Avoid raw C types with dimensions" on page 66         
%             Virtual base classes    & Begin with V, rather than T or M        & VBaseClass\\
              Members                 & Begin with f for field1;                & \\
                                                                                            & functions begin with a capital letter     & fViewList, DrawSelf() \\
              Static variables        & Begin with g; applies to static variables in functions and global variables (excluding static data members of a class) & gDeviceList\\
              Static data members     & Begin with fg; includes class globals   & TView::fgTokenClient\\
              Locals and parameters   & Begin with a word whose initial letter is lowercase; local automatic variables only, treat statics like globals & seed, port, \mbox{theCurrentArea}\\
              Constants               & Begin with k; including names of enumeration constants and constant statics &   kMenuCommand\\
              Acronyms                & All uppercase                           & TNBPName,\\ &&not TNbpName\\
        Template arguments      &       Begin with A                            & AType\\
              Getters and setters     & Begin with Set..., Get..., or Is... (Boolean); use sparingly &  SetLast(), GetNext(), IsDone()\\
              Allocator and adopters  & Begin with Create..., Copy..., Adopt..., or Orphan...; &CreateName()\\
              \hline
                \end{tabular}
                \caption{\textsl{Taligent} conventions used in \ESAF{}}
          \label{tab:conv}

\end{table*}