Comments, Indentation, and Modern C++ Coding Guidelines0%

Primitive Types (int, double, char, bool) & Fixed-Width Integers (cstdint)

Comments, Indentation, and Modern C++ Coding Guidelines

Beginner10 min read•Updated: 2026-10-22

📐 Comments, Indentation, and Modern C++ Coding Guidelines

Introduction

Writing working C++ code is only half the battle. Production software must be maintainable, readable, and structured according to established engineering conventions like the C++ Core Guidelines (championed by Bjarne Stroustrup and Herb Sutter).

📝 Commenting Best Practices

C++ provides two comment styles:

1
Single-line comments: //
2
Multi-line block comments: /* ... */

1// ❌ BAD: Explaining what the code trivially does
2int count = 0; // set count to zero
3 
4// ✅ GOOD: Explaining the *why*, business logic, or edge cases
5// We initialize retry attempts to 0 to adhere to MSK API failover policy
6int retryAttempts = 0;

Doxygen Documentation Comments:

1/**
* @brief Computes the compound annual growth rate (CAGR).
* @param beginningValue Initial portfolio valuation (> 0).
* @param endingValue Final portfolio valuation.
* @param years Total elapsed periods in fractional years.
* @return Double representing the annualized growth rate.
*/
8double calculateCAGR(double beginningValue, double endingValue, double years);

🏛️ Modern C++ Naming Conventions

Entity	Convention	Example
Variables & Functions	`camelCase` or `snake_case`	`studentAge` or `student_age`
Classes & Structs	`PascalCase`	`StudentManager`, `BankAccount`
Constants & `constexpr`	`UPPER_SNAKE_CASE` or `kPascalCase`	`MAX_BUFFER_SIZE`, `kMaxRetries`
Template Parameters	Single capital letters or `PascalCase`	`T`, `ContainerType`

💡 The C++ Core Guidelines Philosophy

F.21: Prefer returning values directly rather than using "out" pointer parameters.
ES.20: Always initialize an object upon declaration.
Con.1: By default, make objects const unless they genuinely require mutation.

Next Lesson

Primitive Types (int, double, char, bool) & Fixed-Width Integers (cstdint)

Continue learning with hands-on practice, examples, and exercises in the upcoming topic.

Related Lessons

Previous Lesson	Next Lesson
Namespaces: Purpose, using namespace std Trade-offs, and Custom Namespaces	Primitive Types (int, double, char, bool) & Fixed-Width Integers (cstdint)

Practice Quiz

Test your understanding of this lesson with 1 questions. Each question has one correct answer.

Previous Next

PreviousPrevNext

MSK Institute • Shikohabad

Loading Page Content...

Preparing courses, live labs, and learning resources.सामग्री लोड हो रही है, कृपया प्रतीक्षा करें...

Connecting serverPlease wait...

💻 Practical Labs🚀 Free Demo📜 Verified Certificates

📝 Commenting Best Practices

C++ provides two comment styles:

Single-line comments: //

Multi-line block comments: /* ... */

1// ❌ BAD: Explaining what the code trivially does
2int count = 0; // set count to zero
3 
4// ✅ GOOD: Explaining the *why*, business logic, or edge cases
5// We initialize retry attempts to 0 to adhere to MSK API failover policy
6int retryAttempts = 0;

Doxygen Documentation Comments:

1/**
* @brief Computes the compound annual growth rate (CAGR).
* @param beginningValue Initial portfolio valuation (> 0).
* @param endingValue Final portfolio valuation.
* @param years Total elapsed periods in fractional years.
* @return Double representing the annualized growth rate.
*/
8double calculateCAGR(double beginningValue, double endingValue, double years);

Entity

Convention

Example

Variables & Functions

camelCase or snake_case

studentAge or student_age

Classes & Structs

PascalCase

StudentManager, BankAccount

Constants & constexpr

UPPER_SNAKE_CASE or kPascalCase

MAX_BUFFER_SIZE, kMaxRetries

Template Parameters

Single capital letters or PascalCase

T, ContainerType

Previous Lesson

Next Lesson

Namespaces: Purpose, using namespace std Trade-offs, and Custom Namespaces

Primitive Types (int, double, char, bool) & Fixed-Width Integers (cstdint)