in einem schlauen Buch stand mal, dass man nicht das "WAS" dokumentieren sollte, sondern das "Warum"
daran halte ich mich, und bin sehr gut damit gefahren.
außerdem kann man heutzutage ja Kommentare auch wegblenden ...
Algorithmenbeschreibungen halte ich für sehr sinnvoll !
Lässt sich mit $Region wegblenden, und stören nicht
Delphi-Quellcode:
{$REGION ' Kommentar Erklärung Algorithmus '}
// LS = LevelSize
// CS= CalcSize
/// ========================================================================
///
/// LEVELSIZE
/// LIST ENTRY STOP TARGET
/// LS CS LS CS LS CS
/// 0 -
/// 3 +3:1401- 3 |_ =3 -3:1306- 0 |_ = -3 -3:1529- 0 |
/// 4 +1:1402- 6 | -1:1307- 3 | -1:1529- 0 |_ = 4
/// 6 +2:1402- 6 |_ =3 -2:1307- 3 |_ = -3 -2:1528- 4 |
/// 8 +2:1403- 10 | -2:1308- 6 | -2:1528- 4 |_ = 4
/// 9 +1:1403- 10 | -1:1308- 6 |_ = -3 -1:1527- 8 |
/// 10 +1:1403- 10 |_ =4 -1:1309- 9 | -1:1527- 8 |_ = 2
/// 12 +2:1409- 15 | -2:1309- 9 |_ = -3 -2:1526- 10 |
/// 15 +3:1409- 15 |_ =5 -3:1310- 12| -3:1526- 10 |
/// 16 +1:1410- 21 | -1:1310- 12| -1:1526- 10 |_ = 6
/// 21 +5:1410- 21 |_ =6 -5:1310- 12|_ = -9 -5:1525- 16 |_ = 5
{$ENDREGION}