Appendix C. Zend Framework Documentation Standard

Table of Contents

C.1. Overview
C.1.1. Scope
C.2. Documentation File Formatting
C.2.1. XML Tags
C.2.2. Maximum Line Length
C.2.3. Indentation
C.2.4. Line Termination
C.2.5. Empty tags
C.2.6. Usage of whitespace within documents
C.2.6.1. Whitespace within tags
C.2.6.2. Multiple line breaks
C.2.6.3. Separation between tags
C.2.7. Program Listings
C.2.8. Notes on specific inline tags
C.2.8.1. classname
C.2.8.2. varname
C.2.8.3. methodname
C.2.8.4. constant
C.2.8.5. filename
C.2.8.6. command
C.2.8.7. code
C.2.9. Notes on specific block tags
C.2.9.1. title
C.3. Recommendations
C.3.1. Use editors without autoformatting
C.3.2. Use Images
C.3.3. Use Case Examples
C.3.4. Avoid Replicating phpdoc Contents
C.3.5. Use Links

C.1. Overview

C.1.1. Scope

This document provides guidelines for creation of the end-user documentation found within Zend Framework. It is intended as a guide to Zend Framework contributors, who must write documentation as part of component contributions, as well as to documentation translators. The standards contained herein are intended to ease translation of documentation, minimize visual and stylistic differences between different documentation files, and make finding changes in documentation easier with diff tools.

You may adopt and/or modify these standards in accordance with the terms of our license.

Topics covered in the Zend Framework documentation standards include documentation file formatting and recommendations for documentation quality.