Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
Skyward Boardcore
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Model registry
Analyze
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Avionics
Software Development
Skyward Boardcore
Wiki
Coding Guidelines
Changes
Page history
New page
Templates
Clone repository
Updated Coding Guidelines (markdown)
authored
7 years ago
by
Luca Erbetta
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
Coding-Guidelines.md
+3
-1
3 additions, 1 deletion
Coding-Guidelines.md
with
3 additions
and
1 deletion
Coding-Guidelines.md
View page @
d28b690b
...
...
@@ -57,11 +57,13 @@ This is done to check if the function had an error.
It's very easy to forget to call an object's init() method, leaving objects in a undefined state.
## **Commenting rules**
-
**Every function shall be
preceded by
a doxygen
-style
comment describing the purpose of the function, its parameters and the return value.**
-
**Every function shall be
documented using
a doxygen comment describing the purpose of the function, its parameters and the return value.**
-
**Write a comment defining pre and post-conditions for most methods.**
This rule is aimed at improving the readability of the code.
-
**Write a comment describing every variable when its meaning is not trivial**
-
**Write a comment describing the purpose of each class, struct and enum**
For a guide on how to use doxygen to document the code, take a look here: https://www.stack.nl/~dimitri/doxygen/manual/docblocks.html
## **Best practices**
These rules are mostly aimed at keeping the code readable and consistent.
...
...
This diff is collapsed.
Click to expand it.