From e4238e662b26cec586d601b778dec422683b498a Mon Sep 17 00:00:00 2001 From: Loek Le Blansch Date: Wed, 6 Nov 2024 13:22:17 +0100 Subject: update contributing.md --- contributing.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) (limited to 'contributing.md') diff --git a/contributing.md b/contributing.md index e88d0a9..8ed3b80 100644 --- a/contributing.md +++ b/contributing.md @@ -49,10 +49,10 @@ that you can click on to open them. class Cars {}; ``` -- Source files contain the following types of comments: +- Source files (.cpp, .hpp) contain the following types of comments: - What is the code supposed to do (optional) - Implementation details (if applicable) -- Header files contain the following types of comments: +- Header files (.h) contain the following types of comments: - Usage documentation (required) - Implementation details (if they affect the header) - Design/data structure decisions (if applicable) @@ -110,7 +110,8 @@ that you can click on to open them. ``` -
- using namespace may not be used in header files, only in source files. + using namespace may not be used in header files (.h, .hpp), only + in source files (.cpp).
GoodBad
example.h: -- cgit v1.2.3