X-Git-Url: https://git.donarmstrong.com/lilypond.git?a=blobdiff_plain;f=Documentation%2FCodingStyle.pod;h=9bf71c38100fcf962a3b8fb698d17f2cd6c57944;hb=daee8243ff1c66bc714455a2d265ab02f03546ec;hp=2ccc103080827a60f4749b3efc09449fc46d0ad1;hpb=5d9f9a9c6ef58ed7c6ed2311f2bc4d75b8722469;p=lilypond.git diff --git a/Documentation/CodingStyle.pod b/Documentation/CodingStyle.pod index 2ccc103080..9bf71c3810 100644 --- a/Documentation/CodingStyle.pod +++ b/Documentation/CodingStyle.pod @@ -16,14 +16,13 @@ in emacs: (add-hook 'c-mode-hook '(lambda ()(setq c-basic-offset 4))) + + (add-hook 'c++-mode-hook '(lambda() (c-set-style "Stroustrup") ) ) -=head2 FILES -The class C is declared in F and -implemented in F. =head2 CLASSES and TYPES: @@ -35,7 +34,7 @@ implemented in F. Class::member() Type Class::member_type_ -the C is a Hungarian notation postfix for C. See below +the C is a Hungarian notation postfix for $C$. See below =head2 COMMENTS @@ -89,7 +88,7 @@ symbols. Staff is the "brains" for PStaff NB: in PCursor (which is part of the library) P stands for PointerCursor -=head2 MEMBERS (2) +=head2 MEMBERS(2) Standard methods: @@ -121,9 +120,9 @@ Notation>. =head2 Hungarian The Hungarian Notation was conceived by or at least got its name from, -the hungarian programmer x. It is a naming convention with the aim to -make code more readable (for fellow programmers) and more accessible -for programmers that are new to a project. +the hungarian programmer Charles Simonyi. It is a naming convention +with the aim to make code more readable (for fellow programmers), and +more accessible for programmers that are new to a project. The essence of the Hungarian Notation is that every identifier has a part which identifies its type (for functions this is the result @@ -210,9 +209,9 @@ with the parts of the names separated by underscores. =over 5 =item C -unsigned cher. (The postfix _by is ambiguous) +unsigned char. (The postfix _by is ambiguous) -=item C +=item C bool =item C @@ -257,7 +256,7 @@ These are precede the prefixes: =item C array -=item C +=item C user built array. =item C @@ -283,19 +282,19 @@ Variable loop: an integer Temporary variable: an unsigned integer =item C -Variable Test: a character +Variable test: a character =item C Variable first_name: a String class object -=item C -Variable first_name: a C array +=item C +Variable last_name: a C array -=item C -Variable Loop: an C that you must delete +=item C +Variable foo: an C that you must delete -=item C -Variable Loop: an C that you must not delete +=item C +Variable bar: an C that you must not delete =back