Changes between Version 11 and Version 12 of Documentation/DevelopmentCenter/DeveloperGuidelines
- Timestamp:
- 06/01/10 01:31:52 (14 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
Documentation/DevelopmentCenter/DeveloperGuidelines
v11 v12 1 = HeuristicLab 3Development Guidelines =1 = HeuristicLab Development Guidelines = 2 2 3 3 == General == … … 5 5 * names of plugins, namespaces, classes, structs, enums, methods, properties, variables, etc. are in English 6 6 * C# 3.0 is used as programming language 7 * HeuristicLab 3is based on the Microsoft .NET Framework 3.5 SP17 * HeuristicLab is based on the Microsoft .NET Framework 3.5 SP1 8 8 9 9 ---- … … 23 23 24 24 === Issue Tracking and Wiki === 25 * [http://trac.edgewall.org/ Trac 0.1 1]25 * [http://trac.edgewall.org/ Trac 0.12] 26 26 27 27 === API Documentation === … … 32 32 33 33 == Coding Conventions == 34 HeuristicLab 3code has to be conform to the guidelines described in [http://msdn.microsoft.com/en-us/library/ms229042.aspx Design Guidelines for Developing Class Libraries].34 HeuristicLab code has to be conform to the guidelines described in [http://msdn.microsoft.com/en-us/library/ms229042.aspx Design Guidelines for Developing Class Libraries]. 35 35 36 36 To ensure consistent formatting of the source code, developers should use identical settings for the Visual Studio Text Editor. The appropriate settings are attached to this page and should be imported in Visual Studio. … … 54 54 * ~~abstract base classes end with `Base` (e.g. `ItemBase`, `OperatorBase`)~~ (this convention has been abandoned with HeuristicLab 3.3) 55 55 * the name of a plugin has to be identical to the project name and the namespace of the plugin (e.g. `HeuristicLab.Data`) 56 * the name of each HeuristicLab 3plugin starts with "`HeuristicLab.`"56 * the name of each HeuristicLab plugin starts with "`HeuristicLab.`" 57 57 * in order to structure plugins hierarchically, sub-namespaces can be used (e.g. `HeuristicLab.Operators` and `HeuristicLab.Operators.Programmable`) 58 58 * each plugin is represented as a component in Trac … … 121 121 All plugins and all release bundles of HeuristicLab have a version number following the schema `Major.Minor.Build.Revision`: 122 122 * `Major` and `Minor` 123 * in order to distinguish from older versions of HeuristicLab (1.1 and 2.0), all plugins of HeuristicLab 3 should have a major version number greater or equal to 3123 * in order to distinguish from older versions of HeuristicLab (1.1 and 2.0), all plugins of HeuristicLab 3.x should have a major version number greater or equal to 3 124 124 * when incrementing the major version number of a plugin, the minor version number has to be set back to 0 125 * the major and minor version numbers have to be included in the assembly name of each HeuristicLab assembly (e.g. `HeuristicLab.Data-3. 2.dll`)125 * the major and minor version numbers have to be included in the assembly name of each HeuristicLab assembly (e.g. `HeuristicLab.Data-3.3.dll`) 126 126 * all major and minor versions of a plugin are kept in the repository and have to be functional in order to assure backwards compatibility 127 127 * `Build`
