oysteikt/mpd
0
0
Fork 0
Code Issues Pull Requests Releases Activity

doc/developer: more code style

Browse Source
This commit is contained in:
Max Kellermann 2017-01-09 17:04:41 +01:00
parent accbd4e82a
commit 28bf100a50
1 changed files with 28 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
doc/developer.xml
View File

@ -38,6 +38,12 @@
</para>
</listitem>
<listitem>
<para>
comment your code, document your APIs
</para>
</listitem>
<listitem>
<para>
the code should be C++14 compliant, and must compile with
@ -46,15 +52,35 @@
</para>
</listitem>
<listitem>
<para>
report error conditions with C++ exceptions, preferable
derived from <varname>std::runtime_error</varname>
</para>
</listitem>
<listitem>
<para>
all code must be exception-safe
</para>
</listitem>
<listitem>
<para>
classes and functions names use CamelCase; variables are
lower-case with words separated by underscore
</para>
</listitem>
<listitem>
<para>
Some example code:
</para>
<programlisting lang="C">static inline int
foo(const char *abc, int xyz)
Foo(const char *abc, int xyz)
{
if (abc == NULL) {
if (abc == nullptr) {
LogWarning("Foo happened!");
return -1;
}