Coding style
From Yate Documentation
(Difference between revisions)
(→PHP code) |
(→File name conventions) |
||
| Line 9: | Line 9: | ||
* All header file names must be lower case | * All header file names must be lower case | ||
* Module file name is always lower case | * Module file name is always lower case | ||
| − | * Engine file names are mixed case just like class names | + | * Engine file names are mixed case just like class names meaning first letter is upper case and the others lower case |
| + | |||
| + | This will keep the code clean and much easier to be read. | ||
====Comments==== | ====Comments==== | ||
Revision as of 11:35, 21 November 2012
Bellow it can be read about the coding style rules to preserve Yate's uniformity of the source code. You can find out about the files name conventions or comments style and a few tips for scripts written in PHP.
Contents |
C++ code
File name conventions
- File names must have .cpp extension, include files must have .h
- All header file names must be lower case
- Module file name is always lower case
- Engine file names are mixed case just like class names meaning first letter is upper case and the others lower case
This will keep the code clean and much easier to be read.
Comments
- Use exclusively C++ style comments in code definition
- Use C style comments in declarations only to provide documentation to kdoc or Doxygen
- Don't use comments to temporarily disable more than one line of code, use #if 0 ... #endif instead
- At the end of source code files please add settings for those that use vi or vim as editor: /* vi: set ts=8 sw=4 sts=4 noet: */
Templates
- Avoid templates if at all possible, even those from standard template library (STL)
- Only use fully inline template classes and functions
PHP code
The style for writing external PHP modules and IVRs is very similar to the one for C++ code.
- Always require_once("libyate.php") towards the start of any module or library
- Never put anything outside the <? ... ?> tags
- Properly declare static methods with the static keyword as required by PHP5 or higher
- Use Yate::Output to send output to console or log file
- Use Yate::Debug to send debugging output to console or log file, this can be turned on or off by providing a boolean argument
See also
