-rw-r--r-- | pwmanager/CodingStyle | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/pwmanager/CodingStyle b/pwmanager/CodingStyle new file mode 100644 index 0000000..67beae8 --- a/dev/null +++ b/pwmanager/CodingStyle | |||
@@ -0,0 +1,36 @@ | |||
1 | |||
2 | PwManager coding style | ||
3 | |||
4 | This program is being developed with the linux-kernel coding-style | ||
5 | in mind. Please read these guidelines first, to get a basic | ||
6 | knowledge of the style. You can find it in | ||
7 | /usr/src/linux/Documentation/CodingStyle for example. | ||
8 | |||
9 | A few other guidelines apply to this program, too: | ||
10 | |||
11 | - Please use new-style C++ casts, if you need to make a cast. | ||
12 | |||
13 | - The class PwMDoc is _only_ for internal document-data- | ||
14 | management. Don't put any view- or user-interface-stuff in | ||
15 | it. Not even a MessageBox. You may use the class PwMDocUi | ||
16 | to add UI-functionality to the document. | ||
17 | |||
18 | - Don't add any document related stuff to another class | ||
19 | than PwMDoc. Exception: Put it into its own class and | ||
20 | invoke this class from within PwMDoc. | ||
21 | |||
22 | - This program makes extensive use of inline functions, for | ||
23 | example to access data-members from outside of the class. | ||
24 | Please try to do so, too. | ||
25 | |||
26 | - Don't try to optimize code for speed, where speed doesn't | ||
27 | matter. Instead optimize it for readability. | ||
28 | |||
29 | - In the code we use the string "PwM" instead of "PwManager", | ||
30 | where needed. This has two reasons. The original name of | ||
31 | this program was "PwM". The second reason is that it's shorter. | ||
32 | |||
33 | - It's an absolute requirement to have fun while developing | ||
34 | code for this application. | ||
35 | |||
36 | Michael Buesch | ||