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
Update Coding Guidelines
authored
3 years ago
by
Luca Conterio
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
Coding-Guidelines.md
+0
-1
0 additions, 1 deletion
Coding-Guidelines.md
with
0 additions
and
1 deletion
Coding-Guidelines.md
View page @
aa643b62
...
@@ -64,7 +64,6 @@ These are not critical rules, but you should follow them in most cases.
...
@@ -64,7 +64,6 @@ These are not critical rules, but you should follow them in most cases.
-
**Write a comment defining pre and post-conditions for most methods.**
-
**Write a comment defining pre and post-conditions for most methods.**
This rule is aimed at improving the readability of the code.
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 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
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
...
...
This diff is collapsed.
Click to expand it.