Skip to content
GitLab
Menu
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
naomod
Model Driven Engineering (MDE)
Source Code Analyzer
Commits
7b31056d
Commit
7b31056d
authored
Dec 23, 2019
by
Gerson Sunyé
Browse files
more conventions
parent
c128189e
Changes
1
Show whitespace changes
Inline
Side-by-side
CONVENTIONS.adoc
View file @
7b31056d
...
...
@@ -7,3 +7,41 @@ que cette règle, dans le format _kebab case_.
Par exemple, si la règle s'appelle `UseArrayListInsteadOfVector`, le nom du
fichier xmi doit être `use-array-list-instead-of-vector.xmi`.
== Commentaires
Distinguez les commentaires internes et externes des règles.
Les commentaires externes s'adressent aux utilisateurs des règles.
Ils expliquent ce que fait la règle.
Ils sont précédés d'un triple tiret: "---".
Les commentaires internes s'adressent aux autres développeurs.
Ils expliquent _comment_ la règle fonctionne.
Ils peuvent aussi expliquer certains choix pas évidents en première lecture.
Par exemple:
[source]
----
--- Returns the number of empty switch cases of a switch statement
helper def: nbEmptySwitchCasesOfASwitchStatement(ss:java!SwitchStatement) : Integer =
-- Gets the number of SwitchCases whoses next sibling is also a SwitchCase
-- and adds the last one if it's a switch case
ss.statements
->excluding(ss.statements.last())
->select(statement |
statement.oclIsTypeOf(java!SwitchCase) and
thisModule.nextSiblingIsSwitchCase(ss.statements.indexOf(statement), ss.statements)
).size() +
ss.statements->select(statement
| statement = ss.statements.last() and statement.oclIsTypeOf(java!SwitchCase)).size()
;
----
== Écriture des règles
Essayez de garder les règles simples.
Évitez d'utiliser les déclarations `iterate`, qui rendent les règles moins lisibles.
Les déclarations `if/then/else` sont strictement interdites.
\ No newline at end of file
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment