Pro PHP- Patterns, Frameworks, Testing and More
55 ■ ■ ■ CHAPTER 6 Documentation and Coding Conventions Documentation is a crucial part of software development. It provides inf ...
(^56) CHAPTER 6 ■ DOCUMENTATION AND CODING CONVENTIONS Others prefer to place the brace on the next line: function foo() { } The ...
CHAPTER 6 ■ DOCUMENTATION AND CODING CONVENTIONS^57 PHP Comments and Lexing To get the most from your documentation efforts, it ...
(^58) CHAPTER 6 ■ DOCUMENTATION AND CODING CONVENTIONS function notimportant{} /* This is a doccomment but it is not associated ...
CHAPTER 6 ■ DOCUMENTATION AND CODING CONVENTIONS^59 Using metadata in this way is especially useful in generating documentation ...
(^60) CHAPTER 6 ■ DOCUMENTATION AND CODING CONVENTIONS Ta b l e 6- 1. Common PHPDoc Tags Tag Description @access public|private| ...
CHAPTER 6 ■ DOCUMENTATION AND CODING CONVENTIONS^61 Listing 6-2 demonstrates a typical PHPDoc comment on a function. Listing 6-2 ...
(^62) CHAPTER 6 ■ DOCUMENTATION AND CODING CONVENTIONS The easiest way to get the phpDocumentor parser tool is to install it fro ...
CHAPTER 6 ■ DOCUMENTATION AND CODING CONVENTIONS^63 The file layout is pretty simple. First, you need to create an XML file that ...
(^64) CHAPTER 6 ■ DOCUMENTATION AND CODING CONVENTIONS apt-get install docbook docbook-xsl docbook-xml xsltproc There are a lot ...
CHAPTER 6 ■ DOCUMENTATION AND CODING CONVENTIONS^65 At this point, you have some HTML output, but it’s all in one file, which ma ...
(^66) CHAPTER 6 ■ DOCUMENTATION AND CODING CONVENTIONS If all went well, you should get this result: Writing mychapter.html for ...
CHAPTER 6 ■ DOCUMENTATION AND CODING CONVENTIONS^67 Reissuing the xsltproc command will work exactly as before, and the chapter1 ...
(^68) CHAPTER 6 ■ DOCUMENTATION AND CODING CONVENTIONS Listing 6-9. DocBook chapter Tags ... Chapter title Exploring chapter ...
CHAPTER 6 ■ DOCUMENTATION AND CODING CONVENTIONS^69 Listing 6-11. DocBook para Tags <para> This is a paragraph and can con ...
(^70) CHAPTER 6 ■ DOCUMENTATION AND CODING CONVENTIONS DatabaseName in the table TableName in the field FieldName. As you can s ...
CHAPTER 6 ■ DOCUMENTATION AND CODING CONVENTIONS^71 There are literally hundreds of possible tags, and these are just the most c ...
McArthur_819-9C06.fm Page 72 Friday, February 22, 2008 8:59 AM ...
73 ■ ■ ■ CHAPTER 7 Reflection API Reflection is one of the most powerful and perhaps one of the most underused features of the P ...
(^74) CHAPTER 7 ■ REFLECTION API ■Note You can find a complete reflection API reference at http://www.php.net/language.oop5. ref ...
«
1
2
3
4
5
6
7
8
9
10
»
Free download pdf