Skip to content

Update coding standard to reflect changes in #1919 #1934

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Update coding standard to reflect changes in #1919 #1934

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions CODING_STANDARD.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,11 @@ Formatting is enforced using clang-format. For more information about this, see
# Comments
- Do not use `/* */`
- Each source and header file must start with a comment block stating the
author. See existing source for an example of the format of this block. This
should be followed by a Doxygen `\file` comment:
author in this format:
```c++
/// Author: Diffblue Ltd.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd rather say /// Author: Your Name, because this is a guideline for all public contributors.

```
This should be followed by a Doxygen `\file` comment:
```c++
/// \file
/// <Some information about this file goes here>
Expand Down