-
Notifications
You must be signed in to change notification settings - Fork 1
/
coding-conventions.html
854 lines (803 loc) · 36.9 KB
/
coding-conventions.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.4.5" />
<title>ZynAddSubFX Coding Conventions</title>
<style type="text/css">
/* Debug borders */
p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
/*
border: 1px solid red;
*/
}
body {
margin: 1em 5% 1em 5%;
}
a {
color: blue;
text-decoration: underline;
}
a:visited {
color: fuchsia;
}
em {
font-style: italic;
color: navy;
}
strong {
font-weight: bold;
color: #083194;
}
tt {
color: navy;
}
h1, h2, h3, h4, h5, h6 {
color: #527bbd;
font-family: sans-serif;
margin-top: 1.2em;
margin-bottom: 0.5em;
line-height: 1.3;
}
h1, h2, h3 {
border-bottom: 2px solid silver;
}
h2 {
padding-top: 0.5em;
}
h3 {
float: left;
}
h3 + * {
clear: left;
}
div.sectionbody {
font-family: serif;
margin-left: 0;
}
hr {
border: 1px solid silver;
}
p {
margin-top: 0.5em;
margin-bottom: 0.5em;
}
ul, ol, li > p {
margin-top: 0;
}
pre {
padding: 0;
margin: 0;
}
span#author {
color: #527bbd;
font-family: sans-serif;
font-weight: bold;
font-size: 1.1em;
}
span#email {
}
span#revnumber, span#revdate, span#revremark {
font-family: sans-serif;
}
div#footer {
font-family: sans-serif;
font-size: small;
border-top: 2px solid silver;
padding-top: 0.5em;
margin-top: 4.0em;
}
div#footer-text {
float: left;
padding-bottom: 0.5em;
}
div#footer-badges {
float: right;
padding-bottom: 0.5em;
}
div#preamble {
margin-top: 1.5em;
margin-bottom: 1.5em;
}
div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
div.admonitionblock {
margin-top: 1.5em;
margin-bottom: 1.5em;
}
div.admonitionblock {
margin-top: 2.5em;
margin-bottom: 2.5em;
}
div.content { /* Block element content. */
padding: 0;
}
/* Block element titles. */
div.title, caption.title {
color: #527bbd;
font-family: sans-serif;
font-weight: bold;
text-align: left;
margin-top: 1.0em;
margin-bottom: 0.5em;
}
div.title + * {
margin-top: 0;
}
td div.title:first-child {
margin-top: 0.0em;
}
div.content div.title:first-child {
margin-top: 0.0em;
}
div.content + div.title {
margin-top: 0.0em;
}
div.sidebarblock > div.content {
background: #ffffee;
border: 1px solid silver;
padding: 0.5em;
}
div.listingblock > div.content {
border: 1px solid silver;
background: #f4f4f4;
padding: 0.5em;
}
div.quoteblock {
padding-left: 2.0em;
margin-right: 10%;
}
div.quoteblock > div.attribution {
padding-top: 0.5em;
text-align: right;
}
div.verseblock {
padding-left: 2.0em;
margin-right: 10%;
}
div.verseblock > div.content {
white-space: pre;
}
div.verseblock > div.attribution {
padding-top: 0.75em;
text-align: left;
}
/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
div.verseblock + div.attribution {
text-align: left;
}
div.admonitionblock .icon {
vertical-align: top;
font-size: 1.1em;
font-weight: bold;
text-decoration: underline;
color: #527bbd;
padding-right: 0.5em;
}
div.admonitionblock td.content {
padding-left: 0.5em;
border-left: 2px solid silver;
}
div.exampleblock > div.content {
border-left: 2px solid silver;
padding: 0.5em;
}
div.imageblock div.content { padding-left: 0; }
span.image img { border-style: none; }
a.image:visited { color: white; }
dl {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
dt {
margin-top: 0.5em;
margin-bottom: 0;
font-style: normal;
color: navy;
}
dd > *:first-child {
margin-top: 0.1em;
}
ul, ol {
list-style-position: outside;
}
ol.arabic {
list-style-type: decimal;
}
ol.loweralpha {
list-style-type: lower-alpha;
}
ol.upperalpha {
list-style-type: upper-alpha;
}
ol.lowerroman {
list-style-type: lower-roman;
}
ol.upperroman {
list-style-type: upper-roman;
}
div.compact ul, div.compact ol,
div.compact p, div.compact p,
div.compact div, div.compact div {
margin-top: 0.1em;
margin-bottom: 0.1em;
}
div.tableblock > table {
border: 3px solid #527bbd;
}
thead {
font-family: sans-serif;
font-weight: bold;
}
tfoot {
font-weight: bold;
}
td > div.verse {
white-space: pre;
}
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
div.tableblock > table[frame="hsides"] {
border-left-style: none;
border-right-style: none;
}
div.tableblock > table[frame="vsides"] {
border-top-style: none;
border-bottom-style: none;
}
div.hdlist {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
div.hdlist tr {
padding-bottom: 15px;
}
dt.hdlist1.strong, td.hdlist1.strong {
font-weight: bold;
}
td.hdlist1 {
vertical-align: top;
font-style: normal;
padding-right: 0.8em;
color: navy;
}
td.hdlist2 {
vertical-align: top;
}
div.hdlist.compact tr {
margin: 0;
padding-bottom: 0;
}
.comment {
background: yellow;
}
@media print {
div#footer-badges { display: none; }
}
div#toctitle {
color: #527bbd;
font-family: sans-serif;
font-size: 1.1em;
font-weight: bold;
margin-top: 1.0em;
margin-bottom: 0.1em;
}
div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
margin-top: 0;
margin-bottom: 0;
}
div.toclevel2 {
margin-left: 2em;
font-size: 0.9em;
}
div.toclevel3 {
margin-left: 4em;
font-size: 0.9em;
}
div.toclevel4 {
margin-left: 6em;
font-size: 0.9em;
}
/* Workarounds for IE6's broken and incomplete CSS2. */
div.sidebar-content {
background: #ffffee;
border: 1px solid silver;
padding: 0.5em;
}
div.sidebar-title, div.image-title {
color: #527bbd;
font-family: sans-serif;
font-weight: bold;
margin-top: 0.0em;
margin-bottom: 0.5em;
}
div.listingblock div.content {
border: 1px solid silver;
background: #f4f4f4;
padding: 0.5em;
}
div.quoteblock-attribution {
padding-top: 0.5em;
text-align: right;
}
div.verseblock-content {
white-space: pre;
}
div.verseblock-attribution {
padding-top: 0.75em;
text-align: left;
}
div.exampleblock-content {
border-left: 2px solid silver;
padding-left: 0.5em;
}
/* IE6 sets dynamically generated links as visited. */
div#toc a:visited { color: blue; }
</style>
</head>
<body>
<div id="header">
<h1>ZynAddSubFX Coding Conventions</h1>
<span id="author">Mark McCurry</span><br />
<span id="revdate">September 27, 2009</span>
</div>
<h2 id="_introduction">Introduction</h2>
<div class="sectionbody">
<div class="paragraph"><p>The goal of this standardization is to create a uniform structure to the
ZynAddSubFX codebase.
Although these are the existing standards, it is not to say that they cannot
change.
For now this document will layout the expectations for the code.</p></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">This is a draft</td>
</tr></table>
</div>
</div>
<h2 id="_indentation">Indentation</h2>
<div class="sectionbody">
<div class="paragraph"><p>Each layer will be 4 spaces further indented than the previous.
There should be no tabs used in the C++ source files.</p></div>
</div>
<h2 id="_file_organization">File Organization</h2>
<div class="sectionbody">
<div class="paragraph"><p>All source code files should either have the .cpp or the .h file extension.
They should all be named after the primary contained class.</p></div>
<div class="paragraph"><p>The contents of the files should follow the following guidelines for their
structure.</p></div>
<h3 id="_include_guards">Include Guards</h3><div style="clear:left"></div>
<div class="paragraph"><p>With every header file, there should be include guards.</p></div>
<h4 id="_example">Example</h4>
<div class="listingblock">
<div class="content"><!-- Generator: GNU source-highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt><span style="font-weight: bold"><span style="color: #000080">#ifndef</span></span> NAME_H
<span style="font-weight: bold"><span style="color: #000080">#define</span></span> NAME_H
<span style="color: #990000">...</span> <span style="font-style: italic"><span style="color: #9A1900">//contents of Name.h</span></span>
<span style="font-weight: bold"><span style="color: #000080">#endif</span></span></tt></pre></div></div>
<h4 id="_justification">Justification</h4>
<div class="paragraph"><p>Standard Practice</p></div>
<h3 id="_source_comments">Source Comments</h3><div style="clear:left"></div>
<div class="paragraph"><p>Within each file there should be a introductory comment before the include
statements.</p></div>
<h4 id="_example_2">Example</h4>
<div class="listingblock">
<div class="content"><!-- Generator: GNU source-highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt><span style="font-style: italic"><span style="color: #9A1900">/*</span></span>
<span style="font-style: italic"><span style="color: #9A1900"> ZynAddSubFX - a software synthesizer</span></span>
<span style="font-style: italic"><span style="color: #9A1900"> File Name - Purpose of File</span></span>
<span style="font-style: italic"><span style="color: #9A1900"> Copyright (C) Dates Developer</span></span>
<span style="font-style: italic"><span style="color: #9A1900"> Copyright (C) Dates Developer</span></span>
<span style="font-style: italic"><span style="color: #9A1900"> Author: Developer name</span></span>
<span style="font-style: italic"><span style="color: #9A1900"> This program is free software; you can redistribute it and/or modify</span></span>
<span style="font-style: italic"><span style="color: #9A1900"> it under the terms of version 2 of the GNU General Public License</span></span>
<span style="font-style: italic"><span style="color: #9A1900"> as published by the Free Software Foundation.</span></span>
<span style="font-style: italic"><span style="color: #9A1900"> This program is distributed in the hope that it will be useful,</span></span>
<span style="font-style: italic"><span style="color: #9A1900"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span></span>
<span style="font-style: italic"><span style="color: #9A1900"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></span>
<span style="font-style: italic"><span style="color: #9A1900"> GNU General Public License (version 2 or later) for more details.</span></span>
<span style="font-style: italic"><span style="color: #9A1900"> You should have received a copy of the GNU General Public License (version 2)</span></span>
<span style="font-style: italic"><span style="color: #9A1900"> along with this program; if not, write to the Free Software Foundation,</span></span>
<span style="font-style: italic"><span style="color: #9A1900"> Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</span></span>
<span style="font-style: italic"><span style="color: #9A1900">*/</span></span>
Include files
<span style="font-style: italic"><span style="color: #9A1900">/**the class*/</span></span>
<span style="font-weight: bold"><span style="color: #0000FF">class</span></span> <span style="color: #009900">bla</span>
<span style="color: #FF0000">{</span>
<span style="color: #FF0000">}</span><span style="color: #990000">;</span>
<span style="font-style: italic"><span style="color: #9A1900">//empty newline</span></span></tt></pre></div></div>
<h4 id="_justification_2">Justification</h4>
<div class="paragraph"><p>This allows for a person to quickly see the use of a set file and the primary
authors.</p></div>
<h3 id="_include_order">Include Order</h3><div style="clear:left"></div>
<div class="paragraph"><p>Unless there is a good reason to do otherwise, the include files should be in
the order of:</p></div>
<div class="ulist"><ul>
<li>
<p>
Corresponding header file (for .cpp files)
</p>
</li>
<li>
<p>
Project headers
</p>
</li>
<li>
<p>
3rd party headers
</p>
</li>
<li>
<p>
standard libraries
</p>
</li>
<li>
<p>
system libraries
</p>
</li>
</ul></div>
<h4 id="_justification_3">Justification</h4>
<div class="paragraph"><p>This allows for someone to clearly see which headers are included in a complex
file.</p></div>
</div>
<h2 id="_naming_conventions">Naming Conventions</h2>
<div class="sectionbody">
<div class="paragraph"><p>All upper case abbreviations are not recommended.
Unless specified otherwise, camel case is preferred in names.</p></div>
<h3 id="_classes">Classes</h3><div style="clear:left"></div>
<div class="paragraph"><p>Classes should always start with a capital letter.</p></div>
<h3 id="_type_names">Type Names</h3><div style="clear:left"></div>
<div class="paragraph"><p>Any given typename should have an <em>_t</em> following the name to show that it is a
typename.</p></div>
<h3 id="_enum_define_and_macro_names">Enum, Define, and Macro names</h3><div style="clear:left"></div>
<div class="paragraph"><p>For the various items, they should be all upper case with underscores to separate
words.</p></div>
<h4 id="_example_3">Example</h4>
<div class="listingblock">
<div class="content"><!-- Generator: GNU source-highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt><span style="font-weight: bold"><span style="color: #000080">#define</span></span> NAME
<span style="font-weight: bold"><span style="color: #000080">#define</span></span> <span style="font-weight: bold"><span style="color: #000000">gt5</span></span><span style="color: #990000">(</span>x<span style="color: #990000">)</span> <span style="color: #990000">(</span>x <span style="color: #990000">></span> <span style="color: #993399">5</span> <span style="color: #990000">:</span> <span style="font-weight: bold"><span style="color: #0000FF">true</span></span> <span style="color: #990000">?</span> <span style="font-weight: bold"><span style="color: #0000FF">false</span></span><span style="color: #990000">)</span>
<span style="font-weight: bold"><span style="color: #0000FF">enum</span></span>
<span style="color: #FF0000">{</span>
REC_UNPREPARED <span style="color: #990000">=</span> <span style="color: #990000">-</span><span style="color: #993399">1</span><span style="color: #990000">,</span>
REC_PREPARED <span style="color: #990000">=</span> <span style="color: #993399">0</span><span style="color: #990000">,</span>
REC_ON <span style="color: #990000">=</span> <span style="color: #993399">1</span>
<span style="color: #FF0000">}</span><span style="color: #990000">;</span></tt></pre></div></div>
</div>
<h2 id="_documentation">Documentation</h2>
<div class="sectionbody">
<div class="paragraph"><p>Doxygen is used to create documentation within header files.
This should be used to tell what each element of the code does.
This includes classes, methods, and instance variables.</p></div>
<h3 id="_example_4">Example</h3><div style="clear:left"></div>
<div class="listingblock">
<div class="content"><!-- Generator: GNU source-highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt><span style="font-style: italic"><span style="color: #9A1900">/**The non bar class*/</span></span>
<span style="font-weight: bold"><span style="color: #0000FF">class</span></span> <span style="color: #009900">foo</span>
<span style="color: #FF0000">{</span>
<span style="font-weight: bold"><span style="color: #0000FF">public</span></span><span style="color: #990000">:</span>
<span style="font-style: italic"><span style="color: #9A1900">/**</span></span>
<span style="font-style: italic"><span style="color: #9A1900"> * The function to preform bar</span></span>
<span style="font-style: italic"><span style="color: #9A1900"> * </span></span><span style="color: #009900">@param</span><span style="font-style: italic"><span style="color: #9A1900"> x the number of bars</span></span>
<span style="font-style: italic"><span style="color: #9A1900"> * </span></span><span style="color: #009900">@return</span><span style="font-style: italic"><span style="color: #9A1900"> success=0 failure=-1</span></span>
<span style="font-style: italic"><span style="color: #9A1900"> */</span></span>
<span style="color: #009900">int</span> <span style="font-weight: bold"><span style="color: #000000">bar</span></span><span style="color: #990000">(</span><span style="color: #009900">long</span> x<span style="color: #990000">)</span> <span style="font-weight: bold"><span style="color: #0000FF">const</span></span><span style="color: #990000">;</span>
<span style="font-weight: bold"><span style="color: #0000FF">private</span></span><span style="color: #990000">:</span>
<span style="color: #009900">long</span> <span style="color: #009900">long</span> cache<span style="color: #990000">;</span><span style="font-style: italic"><span style="color: #9A1900">/**</span></span><span style="font-weight: bold"><span style="color: #0000FF"><the</span></span> <span style="color: #009900">data</span> <span style="color: #009900">cache</span> <span style="color: #009900">for</span> <span style="color: #009900">bar*/</span>
<span style="color: #009900">}</span></tt></pre></div></div>
<h4 id="_justification_4">Justification</h4>
<div class="paragraph"><p>When properly used the Doxygen comments should allow for easy extraction of class
documentation.</p></div>
</div>
<h2 id="_formatting_guidelines">Formatting Guidelines</h2>
<div class="sectionbody">
<h3 id="_brace_policy">Brace Policy</h3><div style="clear:left"></div>
<div class="paragraph"><p>There are two acceptable styles for brace placement:
* Unix Placement (with one space before brace)</p></div>
<div class="listingblock">
<div class="content"><!-- Generator: GNU source-highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt><span style="font-weight: bold"><span style="color: #0000FF">if</span></span> <span style="color: #990000">(</span>condition<span style="color: #990000">)</span> <span style="color: #FF0000">{</span>
statements<span style="color: #990000">;</span>
<span style="color: #FF0000">}</span>
<span style="font-weight: bold"><span style="color: #0000FF">else</span></span> <span style="color: #FF0000">{</span>
statements<span style="color: #990000">;</span>
<span style="color: #FF0000">}</span></tt></pre></div></div>
<div class="ulist"><ul>
<li>
<p>
Under keywords
</p>
</li>
</ul></div>
<div class="listingblock">
<div class="content"><!-- Generator: GNU source-highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt><span style="font-weight: bold"><span style="color: #0000FF">class</span></span> <span style="color: #009900">Foo</span>
<span style="color: #FF0000">{</span>
information<span style="color: #990000">;</span>
<span style="color: #FF0000">}</span></tt></pre></div></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">for one line statements with <strong>if</strong>, <strong>for</strong>, <strong>while</strong> or other control
constructs, no braces is preferred with the statement on the next line.</td>
</tr></table>
</div>
<div class="listingblock">
<div class="content"><!-- Generator: GNU source-highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt><span style="font-weight: bold"><span style="color: #0000FF">if</span></span><span style="color: #990000">(</span><span style="font-weight: bold"><span style="color: #000000">a</span></span><span style="color: #990000">())</span>
<span style="font-weight: bold"><span style="color: #0000FF">return</span></span><span style="color: #990000">;</span>
<span style="font-weight: bold"><span style="color: #0000FF">while</span></span><span style="color: #990000">(</span>condition<span style="color: #990000">)</span>
<span style="font-weight: bold"><span style="color: #000000">c</span></span><span style="color: #990000">();</span></tt></pre></div></div>
<h4 id="_justification_5">Justification</h4>
<div class="paragraph"><p>These two styles with the allowance of no braced statement allows for the
programmer to have flexibility while maintaining an overall consistent style.</p></div>
<h3 id="_if_else_formatting">If Else Formatting</h3><div style="clear:left"></div>
<h4 id="_layout">Layout</h4>
<div class="listingblock">
<div class="content"><!-- Generator: GNU source-highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt><span style="font-weight: bold"><span style="color: #0000FF">if</span></span> <span style="color: #990000">(</span>condition<span style="color: #990000">)</span> <span style="color: #FF0000">{</span> <span style="font-style: italic"><span style="color: #9A1900">//optional comment</span></span>
statements<span style="color: #990000">;</span>
<span style="color: #FF0000">}</span>
<span style="font-weight: bold"><span style="color: #0000FF">else</span></span> <span style="font-weight: bold"><span style="color: #0000FF">if</span></span> <span style="color: #990000">(</span>condition<span style="color: #990000">)</span> <span style="color: #FF0000">{</span> <span style="font-style: italic"><span style="color: #9A1900">//optional comment</span></span>
statements<span style="color: #990000">;</span>
<span style="color: #FF0000">}</span>
<span style="font-weight: bold"><span style="color: #0000FF">else</span></span> <span style="color: #FF0000">{</span> <span style="font-style: italic"><span style="color: #9A1900">//optional comment</span></span>
<span style="color: #FF0000">}</span></tt></pre></div></div>
<div class="paragraph"><p>The alternative brace style is also acceptable.
The optional comments should be used when the condition or the resulting action
due to the condition are not immediately clear.</p></div>
<h4 id="_justification_6">Justification</h4>
<div class="paragraph"><p>This creates a uniform format for the if statements and allows for comments when
appropriate.</p></div>
<h3 id="_switch_statements">Switch Statements</h3><div style="clear:left"></div>
<div class="paragraph"><p>Switch statements should be in the following format:</p></div>
<h4 id="_example_5">Example</h4>
<div class="listingblock">
<div class="content"><!-- Generator: GNU source-highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt><span style="font-weight: bold"><span style="color: #0000FF">switch</span></span><span style="color: #990000">(</span>var<span style="color: #990000">)</span><span style="color: #FF0000">{</span>
<span style="font-weight: bold"><span style="color: #0000FF">case</span></span> <span style="color: #993399">1</span><span style="color: #990000">:</span>
<span style="font-weight: bold"><span style="color: #000000">funcA</span></span><span style="color: #990000">();</span>
<span style="font-weight: bold"><span style="color: #0000FF">break</span></span><span style="color: #990000">;</span>
<span style="font-weight: bold"><span style="color: #0000FF">case</span></span> <span style="color: #993399">2</span><span style="color: #990000">:</span>
<span style="font-weight: bold"><span style="color: #0000FF">case</span></span> <span style="color: #993399">3</span><span style="color: #990000">:</span>
<span style="font-weight: bold"><span style="color: #000000">funcBC</span></span><span style="color: #990000">();</span>
<span style="font-weight: bold"><span style="color: #0000FF">break</span></span><span style="color: #990000">;</span>
<span style="font-weight: bold"><span style="color: #0000FF">default</span></span><span style="color: #990000">:</span>
<span style="font-weight: bold"><span style="color: #000000">funcOther</span></span><span style="color: #990000">();</span>
<span style="font-weight: bold"><span style="color: #0000FF">break</span></span><span style="color: #990000">;</span>
<span style="color: #FF0000">}</span></tt></pre></div></div>
<h4 id="_justification_7">Justification</h4>
<div class="paragraph"><p>Regular formatting</p></div>
<h3 id="_goto_statements">Goto Statements</h3><div style="clear:left"></div>
<div class="paragraph"><p>For a first note, gotos should be used sparingly as overuse may indicate poor
code structure.</p></div>
<div class="paragraph"><p>When they are used, the goto should be left inline with the code.
The label should be placed on its own line with no indentation.</p></div>
<h4 id="_example_6">Example</h4>
<div class="listingblock">
<div class="content"><!-- Generator: GNU source-highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt><span style="font-weight: bold"><span style="color: #0000FF">while</span></span> <span style="color: #990000">(</span>condition<span style="color: #990000">)</span> <span style="color: #FF0000">{</span>
statements<span style="color: #990000">;</span>
<span style="font-weight: bold"><span style="color: #0000FF">if</span></span> <span style="color: #990000">(</span>condition<span style="color: #990000">)</span> <span style="color: #FF0000">{</span>
<span style="font-weight: bold"><span style="color: #0000FF">goto</span></span> abort<span style="color: #990000">;</span>
<span style="color: #FF0000">}</span>
<span style="color: #FF0000">}</span>
abort<span style="color: #990000">:</span>
statements<span style="color: #990000">;</span></tt></pre></div></div>
<h4 id="_justification_8">Justification</h4>
<div class="paragraph"><p>This allows for the goto’s label to be clearly seen and it does not force the
goto to break the flow of reading the main code section.</p></div>
<h3 id="_conditional_operator">Conditional Operator</h3><div style="clear:left"></div>
<div class="paragraph"><p>For brief two state conditions that conditional operator should be used.
There should be spacing around the <em>?</em> and the <em>:</em>.
Parenthesis should be placed around the operator in any case where it helps
clarity.</p></div>
<h4 id="_example_7">Example</h4>
<div class="listingblock">
<div class="content"><!-- Generator: GNU source-highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt><span style="font-weight: bold"><span style="color: #000000">func</span></span><span style="color: #990000">()</span>
<span style="color: #FF0000">{</span>
<span style="font-weight: bold"><span style="color: #0000FF">return</span></span> cond <span style="color: #990000">?</span> true_case <span style="color: #990000">:</span> false_case
<span style="color: #FF0000">}</span>
<span style="font-weight: bold"><span style="color: #000000">some_long_func</span></span><span style="color: #990000">()</span>
<span style="color: #FF0000">{</span>
<span style="font-weight: bold"><span style="color: #0000FF">return</span></span> some_very_long_expression <span style="color: #990000">?</span> true_c
<span style="color: #990000">:</span> false_c<span style="color: #990000">;</span>
<span style="color: #FF0000">}</span></tt></pre></div></div>
<h4 id="_justification_9">Justification</h4>
<div class="paragraph"><p>The added whitespace allows for one to distinguish the cases more easily</p></div>
</div>
<h2 id="_general_whitespace">General Whitespace</h2>
<div class="sectionbody">
<div class="paragraph"><p>There should be a number of places where whitespace should exist and where it
should be removed.</p></div>
<div class="ulist"><ul>
<li>
<p>
Assignment operators should have spacing on both sides
</p>
</li>
<li>
<p>
Incrementing/Decrementing should not be detached from the variable it acts
upon
</p>
</li>
<li>
<p>
Mathematic operators should have spacing on both sides
</p>
</li>
<li>
<p>
There should be no whitespace after a *
</p>
</li>
<li>
<p>
There should be whitespace after a ,
</p>
</li>
<li>
<p>
There should not be whitespace before or in []
</p>
</li>
<li>
<p>
There should be whitespace after ; in for loops
</p>
</li>
</ul></div>
<h3 id="_example_8">Example</h3><div style="clear:left"></div>
<div class="listingblock">
<div class="content"><!-- Generator: GNU source-highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt><span style="color: #009900">char</span> <span style="color: #990000">*</span>a <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #0000FF">new</span></span> <span style="color: #009900">char</span><span style="color: #990000">[</span><span style="color: #993399">5</span><span style="color: #990000">];</span>
<span style="font-weight: bold"><span style="color: #0000FF">for</span></span><span style="color: #990000">(</span><span style="color: #009900">int</span> b <span style="color: #990000">=</span> <span style="color: #993399">2</span><span style="color: #990000">;</span> b <span style="color: #990000"><</span> <span style="color: #993399">4</span><span style="color: #990000">;</span> <span style="color: #990000">++</span>b<span style="color: #990000">)</span>
a<span style="color: #990000">[</span>b<span style="color: #990000">]</span> <span style="color: #990000">=</span> <span style="color: #993399">0</span><span style="color: #990000">;</span>
<span style="font-weight: bold"><span style="color: #000000">foo</span></span><span style="color: #990000">(</span>a<span style="color: #990000">,</span> <span style="color: #993399">5</span><span style="color: #990000">);</span></tt></pre></div></div>
</div>
<h2 id="_misc">Misc</h2>
<div class="sectionbody">
<h3 id="_one_variable_per_line">One Variable Per Line</h3><div style="clear:left"></div>
<div class="paragraph"><p>When defining parameters use one variable per line</p></div>
<h4 id="_example_9">Example</h4>
<div class="listingblock">
<div class="content"><!-- Generator: GNU source-highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt><span style="color: #009900">char</span> <span style="color: #990000">**</span>a <span style="color: #990000">=</span> NULL<span style="color: #990000">;</span> <span style="font-style: italic"><span style="color: #9A1900">/**</span></span><span style="font-weight: bold"><span style="color: #0000FF"><doc</span></span> <span style="color: #009900">string1*/</span>
<span style="color: #009900">char</span> <span style="color: #009900">*b</span> = <span style="color: #009900">new</span> <span style="color: #009900">char[20];</span> <span style="color: #009900">/**<doc</span> <span style="color: #009900">string2*/</span></tt></pre></div></div>
<h4 id="_justification_10">Justification</h4>
<div class="paragraph"><p>This allows for clear documentation in many locations.
This also for clear initialization that is not cluttered into a limited area.</p></div>
<h3 id="_vertical_alignment_for_declarations">Vertical Alignment for Declarations</h3><div style="clear:left"></div>
<div class="paragraph"><p>Declarations should have vertical alignment.</p></div>
<div class="listingblock">
<div class="content"><!-- Generator: GNU source-highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt>Object a<span style="color: #990000">;</span>
string b<span style="color: #990000">;</span>
OscilGen osc<span style="color: #990000">;</span>
<span style="color: #009900">char</span> <span style="color: #990000">*</span>d<span style="color: #990000">;</span>
a <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">Dog</span></span><span style="color: #990000">();</span>
b <span style="color: #990000">=</span> <span style="color: #FF0000">"teststring"</span><span style="color: #990000">;</span>
osc <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">OscilGen</span></span><span style="color: #990000">(</span><span style="color: #993399">5</span><span style="color: #990000">);</span>
d <span style="color: #990000">=</span> NULL<span style="color: #990000">;</span></tt></pre></div></div>
<h4 id="_justification_11">Justification</h4>
<div class="paragraph"><p>improved readability</p></div>
<h3 id="_trailing_whitespace">Trailing Whitespace</h3><div style="clear:left"></div>
<div class="paragraph"><p>One should not use any trailing whitespace, as it only adds noise to diff
utilities.</p></div>
<h3 id="_usable_conditions">Usable conditions</h3><div style="clear:left"></div>
<div class="paragraph"><p>Within constructs like if statements, it is acceptable to use non boolean terms
as the condition.</p></div>
<h4 id="_example_10">Example</h4>
<div class="listingblock">
<div class="content"><!-- Generator: GNU source-highlight 2.9
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt><span style="color: #009900">char</span> <span style="color: #990000">*</span><span style="font-weight: bold"><span style="color: #000000">func</span></span><span style="color: #990000">(</span><span style="color: #009900">char</span> <span style="color: #990000">*</span>a<span style="color: #990000">,</span> <span style="color: #009900">unsigned</span> <span style="color: #009900">int</span> n<span style="color: #990000">)</span><span style="color: #FF0000">{</span>
<span style="font-weight: bold"><span style="color: #0000FF">if</span></span><span style="color: #990000">(!</span>a<span style="color: #990000">)</span><span style="color: #FF0000">{</span>
<span style="font-weight: bold"><span style="color: #0000FF">return</span></span> <span style="font-weight: bold"><span style="color: #0000FF">new</span></span> <span style="color: #009900">char</span><span style="color: #990000">[</span>n<span style="color: #990000">];</span>
<span style="color: #FF0000">}</span>
<span style="font-weight: bold"><span style="color: #0000FF">else</span></span> <span style="font-weight: bold"><span style="color: #0000FF">if</span></span><span style="color: #990000">(</span>a<span style="color: #990000">)</span><span style="color: #FF0000">{</span>
<span style="font-weight: bold"><span style="color: #0000FF">return</span></span> a<span style="color: #990000">;</span>
<span style="color: #FF0000">}</span>
<span style="font-weight: bold"><span style="color: #0000FF">else</span></span><span style="color: #FF0000">{</span>
cout <span style="color: #990000"><<</span> <span style="color: #FF0000">"you sure have an interesting compiler"</span> <span style="color: #990000"><<</span> endl<span style="color: #990000">;</span>
<span style="color: #FF0000">}</span>
<span style="color: #FF0000">}</span></tt></pre></div></div>
<h4 id="_justification_12">Justification</h4>
<div class="paragraph"><p>This eliminates the redundancy needed with extra statements.</p></div>
<h3 id="_indentation_2">Indentation</h3><div style="clear:left"></div>
<div class="paragraph"><p>For each level of code there should be an indentation of 4 spaces.
There should be no tabs used for indentation.</p></div>
<h4 id="_justification_13">Justification</h4>
<div class="paragraph"><p>This should be used so that the code will have a uniform look independent of the
editor being used.</p></div>
<h3 id="_line_length">Line Length</h3><div style="clear:left"></div>
<div class="paragraph"><p>Lines should not exceed 80 characters.</p></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">For information on how to wrap overly long lines see section TODO</td>
</tr></table>
</div>
<h4 id="_justification_14">Justification</h4>
<div class="paragraph"><p>Any line over 80 characters will need to wrap on a default terminal.</p></div>
</div>
<h2 id="_debatable_points">Debatable Points</h2>
<div class="sectionbody">
<div class="paragraph"><p>Should there be spaced after mathematical operators?</p></div>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2009-10-03 10:18:55 EDT
</div>
</div>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-72903778-1', 'auto');
ga('send', 'pageview');
</script>
</body>
</html>