|
PhpDocumentor V3 Logo
phpDocumentor is an open-source documentation generator written in PHP. It automatically parses PHP source code and produces readable API and source code documentation, based on PHPDoc-formatted comments and the structure of the source code itself. It supports documentation of both object-oriented and procedural code. phpDocumentor runs at the command line to create documentation in HTML format. It has support for linking between documentation, incorporating user level documents like tutorials, and creation of highlighted source code with cross referencing to PHP general documentation. phpDocumentor 1.x could parse PHP syntax of PHP 4 up to PHP 5.2. In March 2012, the DocBlox project merged with the 1.x branch of phpDocumentor, resulting in the new major version release of phpDocumentor 2. The first alpha was released on March 16, 2012. phpDocumentor 2.x supported syntax for PHP 5.3 up to 7.0. The 3.0 major version release occurred on October 27, 2020. This brought PHP synt ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
PhpDocumentor V3 Logo
phpDocumentor is an open-source documentation generator written in PHP. It automatically parses PHP source code and produces readable API and source code documentation, based on PHPDoc-formatted comments and the structure of the source code itself. It supports documentation of both object-oriented and procedural code. phpDocumentor runs at the command line to create documentation in HTML format. It has support for linking between documentation, incorporating user level documents like tutorials, and creation of highlighted source code with cross referencing to PHP general documentation. phpDocumentor 1.x could parse PHP syntax of PHP 4 up to PHP 5.2. In March 2012, the DocBlox project merged with the 1.x branch of phpDocumentor, resulting in the new major version release of phpDocumentor 2. The first alpha was released on March 16, 2012. phpDocumentor 2.x supported syntax for PHP 5.3 up to 7.0. The 3.0 major version release occurred on October 27, 2020. This brought PHP synt ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
Web Application
A web application (or web app) is application software that is accessed using a web browser. Web applications are delivered on the World Wide Web to users with an active network connection. History In earlier computing models like client-server, the processing load for the application was shared between code on the server and code installed on each client locally. In other words, an application had its own pre-compiled client program which served as its user interface and had to be separately installed on each user's personal computer. An upgrade to the server-side code of the application would typically also require an upgrade to the client-side code installed on each user workstation, adding to the technical support, support cost and decreasing productivity. In addition, both the client and server components of the application were usually tightly bound to a particular computer architecture and operating system and porting them to others was often prohibitively expensive for ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
Documentation Generator
A documentation generator is a programming tool that generates software documentation intended for programmers (API documentation) or end users (end-user guide), or both, from a set of source code files, and in some cases, binary files. Some generators, such as Javadoc, can use special comments to drive the generation. Doxygen is an example of a generator that can use all of these methods. Types of generation Document generation can be divided in several types: * Batch generation (generic technique) * Text block correspondence (documents created based on pre-defined text blocks) * Forms (forms for websites) * Documentation synthesis: ** Documentation can be inferred from code ** Documentation can be inferred from execution traces ** Documentation can be inferred from mailing lists Some integrated development environments provide interactive access to documentation, code metadata, etc. References See also * Comparison of documentation generators * Template processor * Static c ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
MIT License
The MIT License is a permissive free software license originating at the Massachusetts Institute of Technology (MIT) in the late 1980s. As a permissive license, it puts only very limited restriction on reuse and has, therefore, high license compatibility. Unlike copyleft software licenses, the MIT License also permits reuse within proprietary software, provided that all copies of the software or its substantial portions include a copy of the terms of the MIT License and also a copyright notice. , the MIT License was the most popular software license found in one analysis, continuing from reports in 2015 that the MIT License was the most popular software license on GitHub. Notable projects that use the MIT License include the X Window System, Ruby on Rails, Nim, Node.js, Lua, and jQuery. Notable companies using the MIT License include Microsoft ( .NET), Google ( Angular), and Meta (React). License terms The MIT License has the identifier MIT in the SPDX License List. It is ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
Open-source Software
Open-source software (OSS) is computer software that is released under a license in which the copyright holder grants users the rights to use, study, change, and distribute the software and its source code to anyone and for any purpose. Open-source software may be developed in a collaborative public manner. Open-source software is a prominent example of open collaboration, meaning any capable user is able to participate online in development, making the number of possible contributors indefinite. The ability to examine the code facilitates public trust in the software. Open-source software development can bring in diverse perspectives beyond those of a single company. A 2008 report by the Standish Group stated that adoption of open-source software models has resulted in savings of about $60 billion per year for consumers. Open source code can be used for studying and allows capable end users to adapt software to their personal needs in a similar way user scripts an ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
Documentation Generator
A documentation generator is a programming tool that generates software documentation intended for programmers (API documentation) or end users (end-user guide), or both, from a set of source code files, and in some cases, binary files. Some generators, such as Javadoc, can use special comments to drive the generation. Doxygen is an example of a generator that can use all of these methods. Types of generation Document generation can be divided in several types: * Batch generation (generic technique) * Text block correspondence (documents created based on pre-defined text blocks) * Forms (forms for websites) * Documentation synthesis: ** Documentation can be inferred from code ** Documentation can be inferred from execution traces ** Documentation can be inferred from mailing lists Some integrated development environments provide interactive access to documentation, code metadata, etc. References See also * Comparison of documentation generators * Template processor * Static c ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
Source Code
In computing, source code, or simply code, is any collection of code, with or without comments, written using a human-readable programming language, usually as plain text. The source code of a program is specially designed to facilitate the work of computer programmers, who specify the actions to be performed by a computer mostly by writing source code. The source code is often transformed by an assembler or compiler into binary machine code that can be executed by the computer. The machine code is then available for execution at a later time. Most application software is distributed in a form that includes only executable files. If the source code were included it would be useful to a user, programmer or a system administrator, any of whom might wish to study or modify the program. Alternatively, depending on the technology being used, source code may be interpreted and executed directly. Definitions Richard Stallman's definition, formulated in his 1989 seminal li ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
Application Programming Interface
An application programming interface (API) is a way for two or more computer programs to communicate with each other. It is a type of software interface, offering a service to other pieces of software. A document or standard that describes how to build or use such a connection or interface is called an ''API specification''. A computer system that meets this standard is said to ''implement'' or ''expose'' an API. The term API may refer either to the specification or to the implementation. In contrast to a user interface, which connects a computer to a person, an application programming interface connects computers or pieces of software to each other. It is not intended to be used directly by a person (the end user) other than a computer programmer who is incorporating it into the software. An API is often made up of different parts which act as tools or services that are available to the programmer. A program or a programmer that uses one of these parts is said to ''call'' that ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
PHPDoc
PHPDoc is an adaptation of Javadoc for the PHP programming language. It is still an informal standard for commenting PHP code, but it is in the process of being formalized.PHP-FIG: PSR Working Draft - https://github.com/php-fig/fig-standards/blob/master/proposed/phpdoc.md It allows external document generators like phpDocumentor, which is the de facto standard implementation, to generate documentation of APIs and helps some IDEs such as Zend Studio, NetBeans, JetBrains PhpStorm, ActiveState Komodo Edit and IDE, PHPEdit and Aptana Studio to interpret variable types and other ambiguities in the loosely typed language and to provide improved code completion, type hinting and debugging. PHPDoc supports documentation of both object-oriented and procedural code. On August 13, 2013 the PHP Framework Interoperability Group began writing a formal specification (PSR) for PHPDoc. Example /** * Get all image nodes. * * @param \DOMNode $node The \DOMDocument instance * ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
Object-oriented
Object-oriented programming (OOP) is a programming paradigm based on the concept of "objects", which can contain data and code. The data is in the form of fields (often known as attributes or ''properties''), and the code is in the form of procedures (often known as ''methods''). A common feature of objects is that procedures (or methods) are attached to them and can access and modify the object's data fields. In this brand of OOP, there is usually a special name such as or used to refer to the current object. In OOP, computer programs are designed by making them out of objects that interact with one another. OOP languages are diverse, but the most popular ones are class-based, meaning that objects are instances of classes, which also determine their types. Many of the most widely used programming languages (such as C++, Java, Python, etc.) are multi-paradigm and they support object-oriented programming to a greater or lesser degree, typically in combination with impera ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
Procedural Programming
Procedural programming is a programming paradigm, derived from imperative programming, based on the concept of the ''procedure call''. Procedures (a type of routine or subroutine) simply contain a series of computational steps to be carried out. Any given procedure might be called at any point during a program's execution, including by other procedures or itself. The first major procedural programming languages appeared circa 1957–1964, including Fortran, ALGOL, COBOL, PL/I and BASIC. Pascal and C were published circa 1970–1972. Computer processors provide hardware support for procedural programming through a stack register and instructions for calling procedures and returning from them. Hardware support for other types of programming is possible, but no attempt was commercially successful (for example Lisp machines or Java processors). Procedures and modularity Modularity is generally desirable, especially in large, complicated programs. Inputs are usua ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
Command Line
A command-line interpreter or command-line processor uses a command-line interface (CLI) to receive commands from a user in the form of lines of text. This provides a means of setting parameters for the environment, invoking executables and providing information to them as to what actions they are to perform. In some cases the invocation is conditional based on conditions established by the user or previous executables. Such access was first provided by computer terminals starting in the mid-1960s. This provided an interactive environment not available with punched cards or other input methods. Today, many users rely upon graphical user interfaces and menu-driven interactions. However, some programming and maintenance tasks may not have a graphical user interface and use a command line. Alternatives to the command-line interface include text-based user interface menus (for example, IBM AIX SMIT), keyboard shortcuts, and various desktop metaphors centered on the pointer (usual ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
