Coding style

We need to define a consistent coding style. And implement this in our existing code, as well as enforce it in the future. It should not be too complicated.

https://gitlab.ikp.kit.edu/AirShowerPhysics/corsika/wikis/Code-style-guide

assigned to @darko

I am using clang-format to create a consistent coding style. It works very well. You can use a default style or generate your own .clang-format file.

https://clang.llvm.org/docs/ClangFormat.html https://clang.llvm.org/docs/ClangFormatStyleOptions.html

wow. good to talk about that, let's look into clang-format

Hans, could you provide some practical guidance how to set this up? This would be great.

I don't use a fully automatic solution myself, but you can setup git hooks which automatically run clang-format on every commit. For details, see e.g. https://github.com/andrewseidl/githook-clang-format Note that this guy explicitly says that you should not use his git hooks :) Rather, people should install plugins in their editors that apply clang-format. His page contains links to plugins for popular editors.

Example: I am using clang-format for histogram https://github.com/HDembinski/histogram The repository contains a .clang-format file with a custom style. My editor, SublimeText, has a plugin called "Clang Format" which can be set up to use this .clang-format file and apply it on every save of the source code.

I see. The clang plugin seems to work also for emacs and many other editors. We will just enforce people to switch this on. Now we only have to agree on a specific format. For a start, I will copy the file you use in our repository.

We still will need a small script to format the existing code once... but this should not be difficult.

It is very easy to convert everything all at once. In the source code directory, you do:

clang-format -i -style=file `find . -iname "*.[ch]pp"`

I managed to get this setup with my emacs editor. It was very simple. I included a slightly modified version of .clang-format in the trunk directory.

There is now a ./do-clang-format.sh and a .clang-format in the repository. Please use it, and we can further improve/change it. The code is already formatted accordingly.

This does not yet close this issue, since we need to write some documentation about it...

Remaining task: add and link "contribution guide" GUIDELINES to repository

mentioned in issue #45 (closed)

mentioned in issue #8 (closed)

made the issue visible to everyone

added Development label

created branch 31-coding-style

mentioned in merge request !7 (merged)

created branch 31-coding-style-2

mentioned in commit 3ef64771

The baseline is there, let's start to work with this and further improve on the way.

closed

mentioned in commit de079283