Skip to content

Coding guidelines

nofish edited this page Sep 22, 2021 · 4 revisions

Major additions should be made in a modular format:

  • Make a new directory for your module (e.g. TrackList)
  • Each module should have its own !ModuleInit() function, called from the plugin entry point.
  • Retain the use of COMMAND_T structures for new actions.
  • Global variables are prefixed with g_
  • Member variables are prefixed with m_

sws_extension.cpp contains the main plugin entry point, and sub-modules are initialized there.

We prefer:

  • Spaces for alignment
  • Spaces after commas in parameter lists(like, this);

When possible try to match nearby code for indentation and general style.

About the included .gitignore file:
.gitignore only includes files generated as part of the build process.
So local config files/folders (such as .vscode, .vs/, CMakeSettings.json) are purposely not included.
Contributors may add those to their user-wide .gitignore or .git/info/exclude for sws-specific personal ignore rules (see e.g. here).