Objecteering C# Developer parameters
Overview of the parameter configuration window
Objecteering C# Developer parameters can be used to define the following areas:
· general parameters
· code generation parameters
· external edition
· compilation options
· documentation
· reverse
· diagram creation
· run the application
Note: The names and internal names of each parameter are detailed below. The internal name is only useful for the J designer and is used to call the "getCurrentModuleParameterValue" method.
The "General" group of parameters
Figure 66. The "General" group of Objecteering C# Developer parameters
|
The ...
parameter |
with the
... internal name |
indicates
... |
|
Generation mode |
GenerationMode |
the generation mode. Choose
from round-trip mode and model-driven mode. |
|
Path to .NET Framework (FrameworkPath) |
FrameworkPath |
the path to the .NET Framework. |
|
SDK Version |
SdkVersion |
the version of the SDK. |
The "Code generation" group of parameters
Figure 67. The "Code generation" group of Objecteering C# Developer parameters
|
The …
parameter |
with the
… internal name |
indicates
… |
|
Code generation root |
GenerationPath |
the root in which C# files are generated. |
|
Use Cs naming rules |
UseCsNaming |
that during generation, the names of packages, classes, methods, attributes and parameters will be generated, according to C# recommendations concerning the case (upper or lower) of the first letter. |
|
Generating pre/post-conditions |
PrePostGeneration |
whether the pre and post conditions should be generated on the methods. |
|
Generating invariants |
InvariantsGeneration |
whether invariants should be generated on the classes. |
|
Prefix for fields |
FieldPrefix |
the prefix for the generated attributes. This prefix is used to differentiate the attribute from its properties. |
|
Template for class generation |
CsClassTemplate |
C# code generation template used for classes. |
|
Template for enumeration generation |
CsEnumTemplate |
the C# code generation template used for enumerations. |
|
Generating code profile |
CsProfile |
UML profile used to generate C# code. |
|
Types translation package |
TypeTranslationPackage |
the types package used to generate types in C#. |
|
Generating properties |
PropertiesGeneration |
whether properties (C# style) should be generated. |
|
Authorize auto- implemented properties |
PropGenCSharpV3 |
whether properties should be generated with simplified syntax/ |
|
"description" notes processed as "Csdoc" |
DescriptionAsCsdoc |
the processing of the "description" type notes as well as
the "Csdoc" type notes. |
|
Treat warnings as errors |
ConsistencyControl |
if warnings should be considered as errors. |
Note: For more information on consistency checks, please see "Overview of code generation". For details on notes, please see "Note types".
The "External edition" group of parameters
Figure 68. The "External edition" group of Objecteering C# Developer parameters
|
The ...
parameter |
with the
... internal name |
indicates
... |
|
Command for invoking Visual Studio |
VisualPath |
The Visual Studio "devenv.exe" application. |
|
Generate markers for documentation zones |
DocIdGenerated |
whether or not markers should be generated for documentation zones. |
|
Generate markers for code zones |
IdGenerated |
whether or not markers should be generated for code zones. |
|
Command for invoking external editor |
ExtEditorCommandLine |
the command used to launch an editor to modify the generated code. |
The "Compilation options" group of parameters
Figure 69. The "Compilation options" group of Objecteering C# Developer parameters
|
The ...
parameter |
with the
... internal name |
indicates
... |
|
Compiled files path |
CompilationPath |
the root directory for compiled files. |
|
Command for launching the makefiles |
MakeCommand |
the command used to activate makefile files. This is usually the path to csmak.exe. |
|
Compiler |
CsCompiler |
the C# compiler. |
|
Generating makefile profile |
CsPackageMakefile |
the document template which guides makefile generation for a
component. |
|
Compilation options |
CompilationOptions |
the options for the compilation. |
|
Libraries |
Lib |
path to additional library(ies). |
|
Documentation generation |
GenerateDoc |
whether or not to generate the documentation. |
|
Debug |
Debug |
whether or not to add debug info to the compilation target. |
|
Unsafe |
Unsafe |
that pointer passing during compilation is authorized. |
The "Documentation" group of parameters
Figure 70. The "Documentation" group of Objecteering C# Developer parameters
|
The ...
parameter |
with the
... internal name |
indicates
... |
|
NDocPath |
NDocPath |
the path to the NDoc tool. |
The "Reverse" group of parameters
Figure 71. The "Reverse" group of Objecteering C# Developer parameters
|
The ...
parameter |
with the
... internal name |
indicates
... |
|
Path for the reverse |
ReversePath |
the last path of the source reverse |
The "Run the application" group of parameters
Figure 72. The "Run the application" group of Objecteering C# Developer parameters
|
The ...
parameter |
with the
... internal name |
indicates
... |
|
Application's parameters |
runParameters |
the parameters which are to be passed to the compiled program when
running the application. |
The "Diagram creation" group of parameters
Figure 73. The "Diagram creation" group of Objecteering C# Developer parameters
|
The ...
parameter |
with the
... internal name |
indicates
... |
|
Color of elements in automatically created diagrams |
DiagramColor |
the default color for elements created automatically in diagrams. |
The "Model components" group of parameters
Figure 74. The "Model Components" group of Objecteering C# Developer parameters
|
The ...
parameter |
with the
... internal name |
indicates
... |
|
Add C# source files in model component |
PackageSrcInRamc |
that you
wish to include C# source files in a model component that you are packaging. |
|
Add C# libraries in model component |
PackageDllInRamc |
that you
wish to include C# libraries in a model component that you are packaging. |