Chapter 6. Contributions Guide
(continued from previous page)
SpaceShuttle::SpaceShuttle() : SpaceShip(7)
{
// doing further initialization
}
Sojuz::Sojuz() : SpaceShip(3)
{
// doing further initialization
}
template <typename T>
CargoShip<T>::CargoShip(const T &cargo) : cargo(cargo) { }
} // namespace spaceships
CMake Code Style
• Indent with four spaces.
• Maximum line length 120 characters. When splitting lines, try to focus on readability where possible (for
example, by pairing up keyword/argument pairs on individual lines).
• Don’t put anything in the optional parentheses after endforeach(), endif(), etc.
• Use lowercase (with_underscores) for command, function, and macro names.
• For locally scoped variables, use lowercase (with_underscores).
• For globally scoped variables, use uppercase (WITH_UNDERSCORES).
• Otherwise follow the defaults of the cmake-lint project.
Configuring the Code Style for a Project Using EditorConfig
EditorConfig helps developers define and maintain consistent coding styles between different editors and IDEs. The
EditorConfig project consists of a file format for defining coding styles and a collection of text editor plugins that
enable editors to read the file format and adhere to defined styles. EditorConfig files are easily readable and they work
nicely with version control systems.
For more information, see EditorConfig Website.
Documenting Code
Please see the guide here: Documenting Code.
Structure
To be written.
Language Features
To be written.
6.5.2 Install pre-commit Hook for ESP-IDF Project
Required Dependency
Python 3.6.1 or above. This is our recommendation python version for IDF developers.
Espressif Systems 1575
Submit Document Feedback
Release v4.4
To Next Page
Loading...
Need help?
General