gtsam/DEVELOP.md

22 lines
629 B
Markdown
Raw Normal View History

# Information for Developers
### Coding Conventions
* Classes are Uppercase, methods and functions lowerMixedCase.
2023-01-20 01:45:32 +08:00
* Apart from those naming conventions, we adopt Google C++ style.
* Use meaningful variable names, e.g. `measurement` not `msm`, avoid abbreviations.
### Windows
On Windows it is necessary to explicitly export all functions from the library which should be externally accessible. To do this, include the macro `GTSAM_EXPORT` in your class or function definition.
For example:
```cpp
class GTSAM_EXPORT MyClass { ... };
2022-02-18 00:15:15 +08:00
GTSAM_EXPORT return_type myFunction();
```
2021-08-20 23:11:28 +08:00
More details [here](Using-GTSAM-EXPORT.md).