@@ -16,7 +16,7 @@ years. This is because not every developer:
16
16
17
17
- is aware that code is generally read 10 times more than it is changed.
18
18
- is aware of the potential pitfalls in one programming language, which are
19
- a good way in other .
19
+ a good way in others .
20
20
- is aware of the impact of using (or neglecting to use) particular solutions
21
21
on aspects like security, performance, multi-language support, etc.
22
22
- realizes that not every developer is as capable, skilled or experienced to
@@ -29,7 +29,7 @@ something is not explicitly listed as bad, it does not mean that using it is
29
29
okay.
30
30
31
31
There is a set of rules than can be applied to all situations, regardless of
32
- their context. The include the following:
32
+ their context. These include the following:
33
33
34
34
- [ Principle of least astonishment (a.k.a. POLA)] [ pola ] : you should choose
35
35
solution that everyone can understand, and that keeps them on the right track.
@@ -53,16 +53,16 @@ ordinary developer, exposes unusual behavior, or tries to solve many possible
53
53
future issues, it es very likely the wrong solution and needs redesign. The
54
54
worst response a developer can give yo to these principles is: "But it works!".
55
55
56
- ## Wie fange ich an ?
56
+ ## How do you get started ?
57
57
- Ask all developers to carefully read this document at least once. This will
58
- give them a sense of the kind of guidelines the document containes .
59
- - Make sure evereybody agrees with the rules.
58
+ give them a sense of the kind of guidelines the document contains .
59
+ - Make sure everybody agrees with the rules.
60
60
- Create a [ project checklist] [ project-checklist ] with the most important rules
61
61
and use this checklist for your [ Peer Review] [ peer-review ] .
62
62
- Consider forking the original source and create your own internal version of
63
63
the document.
64
- - Use tools, e. g. IDEs, compiler plugins or build tools, to be able to comply
65
- with these guidelines. THe most IDEs have a intelligent code instpection
64
+ - Use tools, e.g. IDEs, compiler plugins or build tools, to be able to comply
65
+ with these guidelines. THe most IDEs have a intelligent code inspection
66
66
engine, with some configuration, already supporting many aspects of the
67
67
Coding Guidelines.
68
68
@@ -73,10 +73,10 @@ In the last years I often created some kind of code styles and coding
73
73
guidelines, which I used in both, private and professional projects. Now I
74
74
would like to use this knowledge to write some general guidelines.
75
75
76
- ## Is this a official coding standard?
76
+ ## Is this an official coding standard?
77
77
Definitely not! This document does not state that projects must comply with
78
78
these guidelines, neither does it say which guidelines are more important than
79
- other . It is intended to be a guide for anyone who does not want to deal with
79
+ others . It is intended to be a guide for anyone who does not want to deal with
80
80
creating own rules but still wants to have a homogeneous developer experience
81
81
within one team, but also across multiple teams.
82
82
0 commit comments