Guidelines for source code documentation. To avoid language barriers and mixed languages, all comments within the source files (PHP, JS, CSS) are written in English without exception. Exceptions are translations for end users, which must be pleasant to read for native speakers and fully spelled out with all special characters, such as umlauts in German, except for the old-fashioned double-S ß, which is always written as "ss".
🗺️ Stage 0 | 📚 Actual | 📟 2026 07 11 | 📍 Development
PHP & JavaScript Documentation
Use of structured doc-blocks for files, classes, and functions:
File Header
Note: Use of structured doc-blocks. The @module tag contains 1-3 concise English keywords describing the exact context or area like [filename, project area, functionality, context, for example a configuration file for the article editor: "Article editor config"].
Note: The function can be described with its name and/or a few keywords. An optional short description of the function can follow. Parameters are specified with type, name (with $ only in PHP), and description, only if present. The return value is always specified.
/**
* @function: Name and/or keywords
* @description: Optional description of the function
*
* @param type $name: Description of the parameter (if present)
* @param type $anotherName: Additional parameter description
* @return: Return type(s) or void for empty/no return
*/
Class Header
/**
* @class: Name
* @association: Direct connections like parent, child, etc. (if present)
* @description: Core purpose and description of the class
*/
Class Methods (Compact Version)
Note: Parameters are specified with type, name (with $ only in PHP), and description, only if present. The return value is always specified.
/** Short description / keywords
* @cfunc: optional keywords
* @param type $name: Parameter description (if present)
* @return: Return type or void */
Inline Comments (Logic in Code)
Note: Inline comments are only used when truly necessary for brief explanations that cannot be directly inferred from the code, or for structuring in special cases. A well-structured code following the "Self-Documenting Code" principle is always prioritized.
// Single-line comment for simple logic steps
/* Multi-line comment block used when a more
detailed architectural explanation is required */
CSS Documentation & Structuring
Stylesheets are visually structured to maximize readability:
Standardized Code Commenting
Guidelines for source code documentation. To avoid language barriers and mixed languages, all comments within the source files (PHP, JS, CSS) are written in English without exception. Exceptions are translations for end users, which must be pleasant to read for native speakers and fully spelled out with all special characters, such as umlauts in German, except for the old-fashioned double-S ß, which is always written as "ss".
🗺️ Stage 0 | 📚 Actual | 📟 2026 07 11 | 📍 Development
PHP & JavaScript Documentation
Use of structured doc-blocks for files, classes, and functions:
File Header
Note: Use of structured doc-blocks. The @module tag contains 1-3 concise English keywords describing the exact context or area like [filename, project area, functionality, context, for example a configuration file for the article editor: "Article editor config"].
Function Header
Note: The function can be described with its name and/or a few keywords. An optional short description of the function can follow. Parameters are specified with type, name (with $ only in PHP), and description, only if present. The return value is always specified.
Class Header
Class Methods (Compact Version)
Note: Parameters are specified with type, name (with $ only in PHP), and description, only if present. The return value is always specified.
Inline Comments (Logic in Code)
Note: Inline comments are only used when truly necessary for brief explanations that cannot be directly inferred from the code, or for structuring in special cases. A well-structured code following the "Self-Documenting Code" principle is always prioritized.
CSS Documentation & Structuring
Stylesheets are visually structured to maximize readability:
CSS File Header
Main Section
Subsection