Changeset 357 for doc

Show
Ignore:
Timestamp:
06/08/09 02:15:30 (15 years ago)
Author:
mido
Message:

mnoho zmen:
1) presun FindXXX modulu do \system
2) zalozeni dokumentace \doc\local\library_structure.dox
3) presun obsahu \tests\UI primo do \tests
4) namisto \INSTALL zalozen \install.html, je to vhodnejsi pro uzivatele WINDOWS, a snad i obecne
5) snaha o predelani veskerych UI podle nove koncepce, soubory pmsm_ui.h, arx_ui.h, KF_ui.h, libDS_ui.h, libEF_ui.h a loggers_ui.h ponechavam
jen zdokumentacnich duvodu, nic by na nich jiz nemelo zaviset, a po zkontrolovani spravnosti provedenych uprav by mely byt smazany
6) predelani estimatoru tak, aby fungoval s novym UI konceptem
7) vytazeni tridy bdmroot do samostatneho souboru \bdm\bdmroot.h
8) pridana dokumentace pro zacleneni programu ASTYLE do Visual studia, ASTYLE pridan do instalacniho balicku pro Windows

Location:
doc/local
Files:
1 added
1 modified

Legend:

Unmodified
Added
Removed

  • doc/local/codingrules.dox

    r33 r357  
    88\section cr_variables Default Naming Rules for Variables 
    99 
    10 Variables are named using lower-case letters and words are separated 
    11 using under-score. Abbreviations, when used in variable names, are also 
    12 written with lower-case letters. Examples: 
     10Generally, variables are named using lower-case letters and words are separated using 
     11under-score. But there are many exceptions, for instance abbreviations or classical  
     12matematical notations. Therefore, coding rules for variables are quite free. Examples: 
    1313 
    1414<ul> 
    15 <li> \c `fft_size' </li> 
    16 <li> \c `nrof_paths' </li> 
    17 <li> \c `my_variable_name' </li> 
     15<li> \c `FFT_size' </li> 
     16<li> \c `initial_RV' </li> 
     17<li> \c `my_variable' </li> 
    1818</ul> 
    19  
    20 Some variable names or parts of variable names are commonly used in 
    21 several different functions and files to denote the same thing. For 
    22 instance the following common names and prefixes should be used: 
    23  
    24 <ul> 
    25 <li> \c `rows' - number of rows in a matrix </li> 
    26 <li> \c `cols' - number of columns in a matrix </li> 
    27 <li> \c `nrof_' - number of ... </li> 
    28 </ul> 
    29  
    3019 
    3120\section cr_files Default Naming Rules for Files 
    3221 
    3322Files are named using lower-case letters and words are separated using 
    34 under-score. Abbreviations, when used in file names, are also written 
    35 with lower-case letters. 
     23under-score. If an abbreviation is inevitable within file name, it is written with  
     24lower-case letters.  
    3625 
    3726Source files are named using <tt>`.cpp'</tt> suffix, whereas header 
    … …  
    4029<ul> 
    4130<li> <tt>`my_file.h'</tt> </li> 
    42 <li> <tt>`my_file.cpp'</tt> </li> 
     31<li> <tt>`user_info.cpp'</tt> </li> 
    4332</ul> 
    4433 
     34\section cr_file_templates Form of the source files 
     35 
     36For all the library classes, both header file `[filename].h' and source file  
     37`[filename].cpp' should be implemented. And the following few rules should be  
     38respected    
     39 
     40<ul> 
     41 
     42<li> if possible, each `#inline ... ' dircetive should be located within the `.h' 
     43file, one obvious exception is the case of `#inline [filename].h' written in  
     44`[filename].cpp' </li> 
     45 
     46<li> firstly, system headers should be included (i.e. those with brackets  
     47`#include <header_name>'), other headers (like `#include my_header_name.h')  
     48should follow (this rule leads to the faster search of an error on some  
     49compilators) </li> 
     50 
     51<li> source code itself should be placed in the `.cpp' file, `.h' should  
     52contains only class declarations and documentation (this rule has a few exceptions like 
     53 inline functions, templates and some extremely short function bodies)</li> 
     54 
     55</ul> 
     56 
     57Rules considering formatting of the source code itself are stored in the  
     58file \system\astylerc, which is a configuration file for code formating  
     59utility named ASTYLE. To apply them, download the proper version from  
     60its web page http://astyle.sourceforge.net/      
    4561 
    4662\section cr_functions Default Naming Rules for Functions 
    … …  
    7187 
    7288Each new word in a class or structure name should always start with a 
    73 capital letter and the words should be separated with an 
    74 under-score. Abbreviations are written with capital letters. Examples: 
     89capital letter and the words should not be separated. Abbreviations are  
     90written with capital letters. Examples: 
    7591 
    7692<ul> 
    77 <li> \c `My_Class_Name' </li> 
    78 <li> \c `My_Struct_Name' </li> 
     93<li> \c `MyClassName' </li> 
     94<li> \c `MyStructName' </li> 
    7995<li> \c `OFDM' </li> 
    8096</ul>