Developing Tools

---

Auxiliary Development Tools

All auxiliary development tools are contained in tools.

tools/develop.py

This file adds a new module or class to the project.

• To add a new class, say called PhysicalConstants, run this command:

$ tools/develop.py addclass PhysicalConstants

then two files PhysicalConstants.h and PhysicalConstants.cpp will be generated, which can be copied to the path you want to place.

• To add a new module, say called properties, run this command in the root directory:

$ tools/develop.py addmodule properties

then a new folder src/properties will be created. You can add source codes there.

tools/code_review_list.docx

• Code must pass all the items in this file before it is merged to the master branch of the project.

Source Code Editor

• Visual Studio Code is used to edit code.

• Code Spell Checker is used for spelling check of all code. It is an extention of Visual Studio Code.

A brief Chinese tutorial for Visual Studio Code:

• https://zhuanlan.zhihu.com/p/113222681

Developer can also use his/her preferred editor.

Static Analysis

• Cppcheck is used for static analysis of code.

Documentation

• Sphinx is used for general documentation.

Two brief Chinese tutorials for Sphinx:

• https://golden-note.readthedocs.io/zh/latest/sphinx/index.html

• https://iridescent.ink/HowToMakeDocs/index.html