nuclei-sdk/doc/source/develop/codestyle.rst

.. _develop_codestyle:

Code Style
==========

In Nuclei SDK, we use `EditorConfig`_ to maintain our development
coding styles.

Our `editorconfig file`_ is maintained in the root directory of
Nuclei SDK.

You can install editorconfig plugins for your editor, see https://editorconfig.org/#download.

We use `doxygen`_ to comment C/C++ source code.


.. _EditorConfig: https://editorconfig.org/
.. _editorconfig file: https://github.com/Nuclei-Software/nuclei-sdk/tree/master/.editorconfig
.. _doxygen: http://www.doxygen.nl/manual/docblocks.html