capypad
0 Tage Serie
cpp / beginner
Snippet

Kommentare: Dokumentation deines Codes

Kommentare werden vom Compiler ignoriert und dienen der Dokumentation. Einzeilige Kommentare beginnen mit //. Mehrzeilige Kommentare werden mit /* */ umschlossen. Gute Kommentare erklären warum, nicht nur was - sie helfen anderen (und deinem zukünftigen Ich) deinen Code zu verstehen.

snippet.cpp
cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
#include <iostream>
int main() {
int base = 5;
int height = 3;
// Calculate area of triangle
double area = 0.5 * base * height;
/* Multi-line comment:
This formula calculates the area
using the standard geometric formula */
std::cout << "Area: " << area << std::endl;
return 0;
}
Erklärung
1
// Calculate area of triangle
Einzeiliger Kommentar, der den Zweck der nächsten Zeile beschreibt
2
/* Multi-line comment: ... */
Mehrzeiliger Kommentar, der sich über mehrere Zeilen erstreckt für detaillierte Erklärungen