Wiki source code of Style Guidelines

Version 3.1 by aas2 on 2017/05/14 13:19
Show last authors
1 = Project Management =
2
3 The general project **meeting** takes place in the **Railwayroom, Tuesday at 16:00.**
4
5 \\
6
7 = Development Environment =
8
9 == KIELER ==
10
11 Use the[[ KIELER Nightly Build>>url:http://rtsys.informatik.uni-kiel.de/~~kieler/files/nightly/sccharts/||shape="rect"]]. Keep your version up-to-date.
12 You can update to a new version from within your running installation via **Help > Check for updates**. Thus it is not necessary to download the KIELER archive every time.
13
14 Use UTF-8 as codepage (**especially when using Windows**):
15
16 * General > Workspace
17 ** Text file encoding: UTF-8
18
19 It may be helpful to configure the following settings to avoid //Resource is out of sync// warnings in Eclipse:
20
21 * General > Workspace
22 ** Refresh using native hooks or polling: Check
23 ** Refresh on access
24 ** Save automatically before build
25
26 = Code Style =
27
28 == General ==
29
30 Use an indentation of 2 Spaces:
31
32 * General > Text Editors
33 ** Insert Spaces for Tabs: Check
34 ** Displayed Tab Width: 2
35
36 == SCT Style ==
37
38 Use the following conventions when modeling an SCChart:
39
40 * General order
41 ** inputs first
42 ** outputs second
43 ** internal variables third
44 ** regions and states afterwards
45 * Name all regions if you have at least two (no implicit region, unless there is only one)
46 * Naming
47 ** For semantically relevant names, use lower case with underscores (e.g. //state some_long_state_name//)
48 ** For labels and stuff that is intended to increase readability, use more natural english (e.g. //state some_long_state_name "Wait for orders"//)
49
50 {{code language="sct" title="SCT Code Style" linenumbers="true"}}
51 scchart {
52
53 input bool trigger;
54 output bool action0, action1;
55 int fun;
56
57 region first_region "Have fun":
58 // State example
59 initial state example_state
60 --> example_state "Having fun"
61 with trigger
62 / action0 = true
63 ; action1 = false
64 ; fun++
65 ;
66
67 // Region
68 region second_region "Do nothing concurrently":
69
70 initial state init;
71 }
72 {{/code}}
73
74 == Git ==
75
76 Use git.
77
78 Pull before you start coding.
79
80 Add a commit message.
81
82 In case of non-trivial conflicts: ask.
83
84 \\