| Requirement Pattern Source Code Documentation | Description | This pattern expresses the need of documenting the source code and setting how it should be done. | |
| Comments | ---- | ||
| Pattern goal | Stating the necessity of documenting the source code | ||
| Author | Cristina Palomares, Samuel Renault, Carme Quer, Cindy Guerlain | ||
| Sources (0..*) |
| ||
| Keywords (0..*) | Coding rule, Documentation, Level of abstraction, Source code, Source code documentation, Uniformity | ||
| Dependencies (0..*) | ---- | ||
| Requirement Form Source code documented | Description | This form expresses the need of documenting the source code and setting how it should be done. | |
| Comments | Fixed part application: (1); Extended parts application: -Extra Documentation (0..1) -Documentation style and level (0..1) -Coding rules documentation (0..1) -Coding rules documentation onlyIf Documentation style and level | ||
| Version date | 2012-05-23 14:31:52.827 | ||
| Author | Cristina Palomares, Samuel Renault, Carme Quer, Cindy Guerlain | ||
| Sources (0..*) |
| ||
| Fixed Part | Question text | ---- | Form text | The supplier shall document source code. |
| Extended Part Coding rules documentation | Question text | ---- | Form text | The source code documentation shall include the coding rules that define the essential style conventions for obtaining a uniform coding style. |
| Extended Part Documentation style and level | Question text | ---- | Form text | The source code documentation style and level shall be uniform. |
| Extended Part Extra documentation | Question text | ---- | Form text | The documentation of the source code shall include %programmingAspects%. |
| Parameter | Metric | ||
| programmingAspects: is a non-empty set of the different issues related to the programming of a system implementation ("configuration files", "installation procedures", etc.) | ProgrammingAspects: ProgrammingAspects = Set(ProgrammingAspect) ProgrammingAspect = Domain (configuration files, installation procedures, etc.) | ||