![]() ![]() 2.2 LinksĪll the links in this document open in the current browser. For example, arrays may be documented using string keys without quoting their value, $_SESSION, while in practice it is always best to escape the key with quotes: $_SESSION. In other cases the syntax and style used in the example itself are irrelevant and do not follow the coding guidelines outlined below. In most cases its usefulness in the context of the example outweighs its correctness as workable code. When a syntax element consists of a number of alternatives, the alternatives are separated by pipes ( `|`).Įxample code is to be used as examples only and not as tested production code. For example, in the following statement, version is optional. Not to be confused with the use of square brackets in array definitions. In syntax descriptions, square brackets ( ``) are used to indicate optional words or clauses. Example: The `vitals.php` file is important. `Constant width surrounded by quotes`Ĭonstant-width font with surrounding quotes is used for filenames and path names. Example: Use the debug() function to view a variable. 2.1 Typographic Conventions Constant width This section covers the typographical conventions used in this document. Download the module from atutor.ca, and install it like any other module, then run the application to extract the API documentation from ATutor. API documentation can be extracted into a relatively compact form for easy scanning and searching using the phpDocumentor module. 1.1 API Documentationĭetailed API documentation is distributed throughout the ATutor source code, describing functions and classes, and how they are used in developing features. The latest version of this document can always be found at ATutor.ca. These rules and recommendations were created to standardize the distributed development process. To ensure that code is easy to maintain, we urge developers to follow the guidelines outlined below. IntroductionĪTutor, as an open source project, encourages PHP developers to develop their own custom features, and potentially contribute those features so they become a permanent part of ATutor. If you are modifying a previous version of ATutor then you should refer to the version of these guidlines as they are available with that specific version. Versions bundled with ATutor releases are specific to that release. The latest version of this document will always be available in the repository. This document is found in ATutor's documentation/ directory and is maintained along with the rest of the code in the code repository. ![]() 12.6 Database Queries with queryDB() Function.4.2 Creating anfd Maintaining a Git Fork.4.1 Setting up a Git Development Environment.ATutor Developer Documentation ATutor Developer Documentation Table of Contents ![]()
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |