|
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] |
PhpDocumentor
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 sy ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
Comment (computer Programming)
In computer programming, a comment is a programmer-readable explanation or ''annotation'' in the source code of a computer program. They are added with the purpose of making the source code easier for humans to understand, and are generally ignored by compilers and interpreters.Source code can be divided into ''program code'' (which consists of machine-translatable instructions); and ''comments'' (which include human-readable notes and other kinds of annotations in support of the program code). The syntax of comments in various programming languages varies considerably. Comments are sometimes also processed in various ways to generate documentation external to the source code itself by documentation generators, or used for integration with source code management systems and other kinds of external programming tools. The flexibility provided by comments allows for a wide degree of variability, but formal conventions for their use are commonly part of programming style guides. ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
Aptana
Aptana, Inc. is a company that makes web application development tools for use with a variety of programming languages (such as JavaScript, Ruby, PHP and Python). Aptana's main products include Aptana Studio, Aptana Cloud and Aptana Jaxer. Aptana Studio Aptana Studio is an open-source integrated development environment (IDE) for building web applications. Based on Eclipse, it supports JavaScript, HTML, DOM and CSS with code-completion, outlining, JavaScript debugging, error and warning notifications and integrated documentation. Additional plugins allow Aptana Studio to support Ruby on Rails, PHP, Python, Perl, Adobe AIR, Apple iPhone and Nokia WRT (Web Runtime). Aptana Studio is available as a standalone on Windows, Mac OS X and Linux, or as a plugin for Eclipse. Language & platform support PHP Aptana Studio 3 provides the following support for PHP application development: * Syntax Coloring according to the selected theme in the preferences; * Code Assist; * Syntax error ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
Javadoc
Javadoc (originally cased JavaDoc) is a documentation generator created by Sun Microsystems for the Java language (now owned by Oracle Corporation) for generating API documentation in HTML format from Java source code. The HTML format is used for adding the convenience of being able to hyperlink related documents together. The "doc comments" format used by Javadoc is the de facto industry standard for documenting Java classes. Some IDEs, like IntelliJ IDEA, NetBeans and Eclipse, automatically generate Javadoc templates. Many file editors assist the user in producing Javadoc source and use the Javadoc info as internal references for the programmer. Javadoc also provides an API for creating doclets and taglets, which allows users to analyze the structure of a Java application. This is how JDiff can generate reports of what changed between two versions of an API. Javadoc does not affect performance in Java as all comments are removed at compilation time. Writing comments and Javado ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
Comparison Of Documentation Generators
The following tables compare general and technical information for a number of documentation generators. Please see the individual products' articles for further information. Unless otherwise specified in footnotes, comparisons are based on the stable versions without any add-ons, extensions or external programs. Note that many of the generators listed are no longer maintained. General information Basic general information about the generators, including: creator or company, license, and price. Supported formats The output formats the generators can write. Other features See also * Code readability * Documentation generator * Literate programming * Self-documenting code Notes References {{DEFAULTSORT:Comparison Of Documentation Generators Documentation generators Documentation is any communicable material that is used to describe, explain or instruct regarding some attributes of an object, system or procedure, such as its parts, assembly, installation, ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
Doxygen
Doxygen ( ) is a documentation generator and static analysis tool for software source trees. When used as a documentation generator, Doxygen extracts information from specially-formatted comments within the code. When used for analysis, Doxygen uses its parse tree to generate diagrams and charts of the code structure. Doxygen can cross reference documentation and code, so that the reader of a document can easily refer to the actual code. Doxygen is free software, released under the terms of the GNU General Public License version2 (GPLv2). Design Like Javadoc, Doxygen extracts documentation from source file comments. In addition to the Javadoc syntax, Doxygen supports the documentation tags used in the Qt toolkit and can generate output in HyperText Markup Language (HTML) as well as in Microsoft Compiled HTML Help (CHM), Rich Text Format (RTF), Portable Document Format (PDF), LaTeX, PostScript or man pages. Uses Programming languages supported by Doxygen include C, C++, ... [...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] |
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] |
Autocomplete
Autocomplete, or word completion, is a feature in which an application predicts the rest of a word a user is typing. In Android and iOS smartphones, this is called predictive text. In graphical user interfaces, users can typically press the tab key to accept a suggestion or the down arrow key to accept one of several. Autocomplete speeds up human-computer interactions when it correctly predicts the word a user intends to enter after only a few characters have been typed into a text input field. It works best in domains with a limited number of possible words (such as in command line interpreters), when some words are much more common (such as when addressing an e-mail), or writing structured and predictable text (as in source code editors). Many autocomplete algorithms learn new words after the user has written them a few times, and can suggest alternatives based on the learned habits of the individual user. Definition Original purpose The original purpose of word predic ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
Typed And Untyped Languages
A programming language is a system of notation for writing computer programs. Most programming languages are text-based formal languages, but they may also be graphical. They are a kind of computer language. The description of a programming language is usually split into the two components of syntax (form) and semantics (meaning), which are usually defined by a formal language. Some languages are defined by a specification document (for example, the C programming language is specified by an ISO Standard) while other languages (such as Perl) have a dominant implementation that is treated as a reference. Some languages have both, with the basic language defined by a standard and extensions taken from the dominant implementation being common. Programming language theory is the subfield of computer science that studies the design, implementation, analysis, characterization, and classification of programming languages. Definitions There are many considerations when defining wha ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
ActiveState Komodo
Komodo Edit is a free and open source text editor for dynamic programming languages. It was introduced in January 2007 to complement ActiveState's commercial Komodo IDE. As of version 4.3, Komodo Edit is built atop the Open Komodo project. Komodo IDE is no longer supported and maintained by developers for Python. History Komodo Edit 4.0 was originally a freeware version of Komodo IDE 4.0, released in 2007-02-14. On 2008-03-05, ActiveState Software Inc. announced Komodo Edit 4.3 to be open-sourced software, licensed under Mozilla Public License (MPL), GNU General Public License (GPL), and GNU Lesser Public License (LGPL). Open Komodo It is a subset version of Komodo Edit, with initial goal of Web development. The code was to be available between late October or early November 2007, with Open Komodo code repository created by ActiveState in August 2007. On 2007-10-30, ActiveState Software Inc. announced the release of Open Komodo. The initial release was 1.0.0 Alpha 1. Komodo S ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
PHPEdit
PHPEdit is a commercial IDE developed by the French company WaterProof SARL. It runs on the Microsoft Windows operating system, and is designed mainly for the PHP language, but supports many other languages such as CSS, HTML, JavaScript, INI, PHPEditScript, PlainText, SQL, XML, and XSLT. As of August 2017, both PHPEdit and Waterproof websites are dead; product status is unknown. Features * Syntax highlighting for multiple languages in one document. Supported languages are CSS, HTML, JavaScript, INI, PHPEditScript, PHP, PlainText, SQL, XML, and XSLT * Code Hint for HTML, SQL and PHP * Code Insight for HTML, SQL and PHP * Code beautifier * Integrated PHP debugger * Automatic syntax checking * Help generator * Task Reporter * Customizable shortcuts * More than 150 scriptable commands * Keyboard templates * To-do report generator * QuickMarks * File Explorer * FTP Explorer * EZ Publish integration * CVS and SVN integration * Solution Explorer * Database Explorer * Code b ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
