derek/DRAMSys
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Coding-style doc updated

Browse Source
This commit is contained in:
Éder F. Zulian
2018-04-11 20:10:35 +02:00
parent 73c95f8f8f
commit 61fabe7d19
1 changed files with 3 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
coding-style.md
View File

@@ -70,10 +70,9 @@ char itemDelimiter = ' ';
``` ```
Classes always start with an upper-case letter (e.g, MemoryManager, Classes always start with an upper-case letter (e.g, MemoryManager,
TracePlayer, PythonCaller, etc.), being **DRAMSys** a notable exception to the TracePlayer, PythonCaller, etc.).
rule. Acronyms are camel-cased (e.g., TlmRecorder, not TLMRecorder, Dram, not DRAM),
being **DRAMSys** a notable exception to the rule.
Acronyms are camel-cased (e.g., TlmRecorder, not TLMRecorder, Dram, not DRAM).
#### Whitespace #### Whitespace
Always use a single space after a keyword and before a curly brace: Always use a single space after a keyword and before a curly brace:
@@ -124,7 +123,6 @@ if (foo)
bar(); bar();
``` ```
## DRAMSys Coding Style for Python Code ## DRAMSys Coding Style for Python Code
We follow the PEP8 style guide. We follow the PEP8 style guide.