Php documentor
Download as pptx, pdf0 likes323 views
PHPDocumentor 是一款用于生成 PHP 程序 API 文档的工具，通过分析带注释的代码以生成多种格式的文档，如 HTML 和 PDF。它支持 docblock 格式的注释，能够提供丰富的功能说明、参数信息及示例，从而帮助开发者理解代码。正确使用 PHPDocumentor 有助于提高软件项目的文档质量及开发效率。
1 of 27
Download to read offline
Ad
Recommended
Php documentor
Php documentorCloud Liao phpDocumentor 是一个用于生成 PHP 程序文档的工具，支持 API 文档的快速生成，并可以输出为多种格式。用户可以通过编写特定格式的注释（docblock）为代码提供详细说明。该工具不仅提高了文档生成效率，还促使程序员养成良好的注释习惯。
2024 Trend Updates: What Really Works In SEO & Content Marketing
2024 Trend Updates: What Really Works In SEO & Content MarketingSearch Engine Journal The document outlines key SEO and content marketing trends for 2024, emphasizing the impact of AI, the importance of E-E-A-T (Experience, Expertise, Authoritativeness, Trustworthiness), and a shift towards user-centric content strategies. It advises against focusing on outdated trends like voice search and stresses the need for creating value-driven, authoritative content. Additionally, it highlights the need to leverage AI as a supportive tool rather than relying solely on it for content creation.
Storytelling For The Web: Integrate Storytelling in your Design Process
Storytelling For The Web: Integrate Storytelling in your Design ProcessChiara Aliotta The document outlines a livestream presentation by Chiara Aliotta on integrating storytelling into web design to enhance user experiences. It covers the storytelling process for designers, emphasizing aspects such as understanding the audience, structuring narratives, and creating emotional connections. The presentation also includes case studies and practical examples to demonstrate effective storytelling in UX/UI design.
Artificial Intelligence, Data and Competition – SCHREPEL – June 2024 OECD dis...
Artificial Intelligence, Data and Competition – SCHREPEL – June 2024 OECD dis...OECD Directorate for Financial and Enterprise Affairs This presentation by Thibault Schrepel, Associate Professor of Law at Vrije Universiteit Amsterdam University, was made during the discussion “Artificial Intelligence, Data and Competition” held at the 143rd meeting of the OECD Competition Committee on 12 June 2024. More papers and presentations on the topic can be found at oe.cd/aicomp.
This presentation was uploaded with the author’s consent.
How to Leverage AI to Boost Employee Wellness - Lydia Di Francesco - SocialHR...
How to Leverage AI to Boost Employee Wellness - Lydia Di Francesco - SocialHR...SocialHRCamp The document discusses leveraging AI to enhance employee wellness through data analytics, automating tasks, and personalized wellness apps, emphasizing the shared responsibility of employee well-being between leaders and organizations. It outlines best practices for using AI in wellness strategies, including ensuring data privacy and security, understanding employee needs, and promoting inclusivity. Lydia Di Francesco, a wellness specialist, shares insights to optimize workplace wellness strategy using AI-driven data analytics and encourages collaboration and transparency.
2024 State of Marketing Report – by Hubspot
2024 State of Marketing Report – by HubspotMarius Sescu The State of Marketing 2024 report highlights the transformative impact of AI and automation, emphasizing the importance of personalization and engagement to drive growth in a competitive landscape. Marketers are focusing on optimizing budgets, leveraging social media for brand awareness, and utilizing AI tools to enhance efficiency across tasks. Key trends for 2024 include the rise of experiential marketing, content creation that meets user needs, and strengthened connections through personalized customer experiences.
Everything You Need To Know About ChatGPT
Everything You Need To Know About ChatGPTExpeed Software ChatGPT is an AI chatbot developed by OpenAI, built on advanced language models to facilitate human-like conversational interactions. Launched in November 2022, it utilizes a transformer architecture to understand and generate text, with applications ranging from content creation to customer service. Despite its capabilities, there are concerns about potential misuse and biases in its responses, which OpenAI aims to mitigate through moderation and user feedback.
Product Design Trends in 2024 | Teenage Engineerings
Product Design Trends in 2024 | Teenage EngineeringsPixeldarts The realm of product design is a constantly changing environment where technology and style intersect. Every year introduces fresh challenges and exciting trends that mold the future of this captivating art form. In this piece, we delve into the significant trends set to influence the look and functionality of product design in the year 2024.
How Race, Age and Gender Shape Attitudes Towards Mental Health
How Race, Age and Gender Shape Attitudes Towards Mental HealthThinkNow The November 2023 mental health report indicates that 70% of respondents rate their mental health as 'good' or 'excellent,' with higher diagnoses reported among African Americans and non-Hispanic whites compared to Hispanics and Asians. Younger generations, particularly Gen Z and millennials, are more likely to experience mental health challenges, seek information online, and report that their mental health impacts their work and relationships. Half of the respondents feel comfortable discussing their mental health with professionals, although Gen Z shows the least comfort in this area.
AI Trends in Creative Operations 2024 by Artwork Flow.pdf
AI Trends in Creative Operations 2024 by Artwork Flow.pdfmarketingartwork Creative operations teams expect increased AI use in 2024. Currently, over half of tasks are not AI-enabled, but this is expected to decrease in the coming year. ChatGPT is the most popular AI tool currently. Business leaders are more actively exploring AI benefits than individual contributors. Most respondents do not believe AI will impact workforce size in 2024. However, some inhibitions still exist around AI accuracy and lack of understanding. Creatives primarily want to use AI to save time on mundane tasks and boost productivity.
Skeleton Culture Code
Skeleton Culture CodeSkeleton Technologies Organizational culture includes values, norms, systems, symbols, language, assumptions, beliefs, and habits that influence employee behaviors and how people interpret those behaviors. It is important because culture can help or hinder a company's success. Some key aspects of Netflix's culture that help it achieve results include hiring smartly so every position has stars, focusing on attitude over just aptitude, and having a strict policy against peacocks, whiners, and jerks.
PEPSICO Presentation to CAGNY Conference Feb 2024
PEPSICO Presentation to CAGNY Conference Feb 2024Neil Kimberley PepsiCo provided a safe harbor statement noting that any forward-looking statements are based on currently available information and are subject to risks and uncertainties. It also provided information on non-GAAP measures and directing readers to its website for disclosure and reconciliation. The document then discussed PepsiCo's business overview, including that it is a global beverage and convenient food company with iconic brands, $91 billion in net revenue in 2023, and nearly $14 billion in core operating profit. It operates through a divisional structure with a focus on local consumers.
Content Methodology: A Best Practices Report (Webinar)
Content Methodology: A Best Practices Report (Webinar)contently This document provides an overview of content methodology best practices. It defines content methodology as establishing objectives, KPIs, and a culture of continuous learning and iteration. An effective methodology focuses on connecting with audiences, creating optimal content, and optimizing processes. It also discusses why a methodology is needed due to the competitive landscape, proliferation of channels, and opportunities for improvement. Components of an effective methodology include defining objectives and KPIs, audience analysis, identifying opportunities, and evaluating resources. The document concludes with recommendations around creating a content plan, testing and optimizing content over 90 days.
How to Prepare For a Successful Job Search for 2024
How to Prepare For a Successful Job Search for 2024Albert Qian The document provides guidance on preparing a job search for 2024. It discusses the state of the job market, focusing on growth in AI and healthcare but also continued layoffs. It recommends figuring out what you want to do by researching interests and skills, then conducting informational interviews. The job search should involve building a personal brand on LinkedIn, actively applying to jobs, tailoring resumes and interviews, maintaining job hunting as a habit, and continuing self-improvement. Once hired, the document advises setting new goals and keeping skills and networking active in case of future opportunities.
Social Media Marketing Trends 2024 // The Global Indie Insights
Social Media Marketing Trends 2024 // The Global Indie InsightsKurio // The Social Media Age(ncy) The 2024 social media marketing trends report highlights significant shifts influenced by generative AI, including the emergence of personalized content, the rise of virtual influencers, and a stronger focus on user-generated content. Insights were gathered from 33 experts across 23 leading independent agencies, providing a perspective that emphasizes creativity and authenticity in marketing strategies. Key trends also include the blending of B2B and B2C approaches, reflecting changes in consumer behavior and the evolving landscape of social media engagement.
Trends In Paid Search: Navigating The Digital Landscape In 2024
Trends In Paid Search: Navigating The Digital Landscape In 2024Search Engine Journal The document discusses trends in paid search for 2024, highlighting changes in user behavior, the implications for financial services, and privacy challenges. It emphasizes the importance of adapting search strategies, utilizing AI-driven tools like performance max and smart bidding, and leveraging first-party data for better marketing efficacy. Key takeaways include holistic SEO and SEM approaches, monitoring shifting user intents, and the need for continuous performance evaluation.
5 Public speaking tips from TED - Visualized summary
5 Public speaking tips from TED - Visualized summarySpeakerHub The document outlines five public speaking tips from Chris Anderson, TED Talks curator, emphasizing the importance of eye contact, vulnerability, humor, humility, and storytelling. These skills are presented as essential for engaging audiences effectively and are increasingly valuable in today's economy. The article posits that mastering these techniques can enhance speakers' ability to communicate ideas powerfully.
ChatGPT and the Future of Work - Clark Boyd
ChatGPT and the Future of Work - Clark Boyd Clark Boyd The document provides an overview of generative AI, particularly focusing on ChatGPT and its implications for business and the job market. It discusses the rapid growth of generative AI, its applications in marketing, and the skills needed for the AI era while addressing potential job displacement and the need for adaptation. The agenda includes a Q&A session and emphasizes rethinking work in collaboration with AI technology.
Getting into the tech field. what next
Getting into the tech field. what next Tessa Mero The document provides career advice for getting into the tech field, including:
- Doing projects and internships in college to build a portfolio.
- Learning about different roles and technologies through industry research.
- Contributing to open source projects to build experience and network.
- Developing a personal brand through a website and social media presence.
- Networking through events, communities, and finding a mentor.
- Practicing interviews through mock interviews and whiteboarding coding questions.
Google's Just Not That Into You: Understanding Core Updates & Search Intent
Google's Just Not That Into You: Understanding Core Updates & Search IntentLily Ray 1. Core updates from Google periodically change how its algorithms assess and rank websites and pages. This can impact rankings through shifts in user intent, site quality issues being caught up to, world events influencing queries, and overhauls to search like the E-A-T framework.
2. There are many possible user intents beyond just transactional, navigational and informational. Identifying intent shifts is important during core updates. Sites may need to optimize for new intents through different content types and sections.
3. Responding effectively to core updates requires analyzing "before and after" data to understand changes, identifying new intents or page types, and ensuring content matches appropriate intents across video, images, knowledge graphs and more.
How to have difficult conversations
How to have difficult conversations Rajiv Jayarajah, MAppComm, ACC The document provides essential tips on how to handle difficult conversations in a workplace setting, emphasizing the importance of preparation, environment, and timing. It highlights that many employees dread such conversations, often leading to avoidance and worsening situations. Ultimately, the guide aims to promote positive outcomes while maintaining professional relationships.
Introduction to Data Science
Introduction to Data ScienceChristy Abraham Joy The document discusses the rise and importance of data science and machine learning, highlighting the growing demand for data scientists and the challenges they face. It explains machine learning concepts such as supervised and unsupervised learning, along with various real-world applications and the necessary steps involved in a machine learning workflow. Additionally, the document emphasizes the iterative process of model improvement and feature engineering used to enhance machine learning outcomes.
Time Management & Productivity - Best Practices
Time Management & Productivity - Best PracticesVit Horky The document outlines best practices for time management and productivity, focusing on effective meeting habits, structured work blocks, and the importance of reflection and goal setting. It emphasizes the need for proper planning, the use of appropriate tools, and prioritizing tasks to enhance both personal and team efficiency. Additionally, personal anecdotes and strategies are shared to encourage a positive mindset and enjoyment in achieving work-related goals.
The six step guide to practical project management
The six step guide to practical project managementMindGenius The document outlines a simplified six-step guide to project management designed for individuals lacking formal training. It emphasizes the importance of understanding project objectives, gathering stakeholder requirements, defining project scope, scheduling tasks, monitoring progress, and conducting a retrospective meeting. Additionally, it promotes the use of the MindGenius tool for effective project planning and execution.
Beginners Guide to TikTok for Search - Rachel Pearson - We are Tilt __ Bright...
Beginners Guide to TikTok for Search - Rachel Pearson - We are Tilt __ Bright...RachelPearson36 A presentation for absolute beginners who have never touched TikTok and may be a bit scared of it!
Unlocking the Power of ChatGPT and AI in Testing - A Real-World Look, present...
Unlocking the Power of ChatGPT and AI in Testing - A Real-World Look, present...Applitools The document discusses the application of ChatGPT and AI in software testing and programming, including its strengths and limitations. It covers ChatGPT's capabilities, such as code writing, refactoring, and debugging, and emphasizes the importance of human expertise in the software development life cycle. Additionally, it highlights various AI tools, potential pitfalls, and offers strategies for integrating AI into testing practices.
12 Ways to Increase Your Influence at Work
12 Ways to Increase Your Influence at WorkGetSmarter The document outlines strategies for increasing influence in the workplace, emphasizing the importance of setting clear goals, building trust, and demonstrating consistency in actions. It also highlights the significance of relationship building, proactivity, and self-awareness regarding influencing styles. Lastly, it underscores that true leadership is about impact, influence, and inspiration rather than titles.
ChatGPT webinar slides
ChatGPT webinar slidesAlireza Esmikhani The document discusses various AI tools from OpenAI like GPT-3 and DALL-E 2, as well as ChatGPT. It explores how search engines are using AI and things to consider around AI-generated content. Potential SEO uses of ChatGPT are also presented, such as generating content at scale, conducting topic research, and automating basic coding tasks. The document encourages further reading on using ChatGPT for SEO purposes.
More Related Content
Featured (20)
How Race, Age and Gender Shape Attitudes Towards Mental Health
How Race, Age and Gender Shape Attitudes Towards Mental HealthThinkNow The November 2023 mental health report indicates that 70% of respondents rate their mental health as 'good' or 'excellent,' with higher diagnoses reported among African Americans and non-Hispanic whites compared to Hispanics and Asians. Younger generations, particularly Gen Z and millennials, are more likely to experience mental health challenges, seek information online, and report that their mental health impacts their work and relationships. Half of the respondents feel comfortable discussing their mental health with professionals, although Gen Z shows the least comfort in this area.
AI Trends in Creative Operations 2024 by Artwork Flow.pdf
AI Trends in Creative Operations 2024 by Artwork Flow.pdfmarketingartwork Creative operations teams expect increased AI use in 2024. Currently, over half of tasks are not AI-enabled, but this is expected to decrease in the coming year. ChatGPT is the most popular AI tool currently. Business leaders are more actively exploring AI benefits than individual contributors. Most respondents do not believe AI will impact workforce size in 2024. However, some inhibitions still exist around AI accuracy and lack of understanding. Creatives primarily want to use AI to save time on mundane tasks and boost productivity.
Skeleton Culture Code
Skeleton Culture CodeSkeleton Technologies Organizational culture includes values, norms, systems, symbols, language, assumptions, beliefs, and habits that influence employee behaviors and how people interpret those behaviors. It is important because culture can help or hinder a company's success. Some key aspects of Netflix's culture that help it achieve results include hiring smartly so every position has stars, focusing on attitude over just aptitude, and having a strict policy against peacocks, whiners, and jerks.
PEPSICO Presentation to CAGNY Conference Feb 2024
PEPSICO Presentation to CAGNY Conference Feb 2024Neil Kimberley PepsiCo provided a safe harbor statement noting that any forward-looking statements are based on currently available information and are subject to risks and uncertainties. It also provided information on non-GAAP measures and directing readers to its website for disclosure and reconciliation. The document then discussed PepsiCo's business overview, including that it is a global beverage and convenient food company with iconic brands, $91 billion in net revenue in 2023, and nearly $14 billion in core operating profit. It operates through a divisional structure with a focus on local consumers.
Content Methodology: A Best Practices Report (Webinar)
Content Methodology: A Best Practices Report (Webinar)contently This document provides an overview of content methodology best practices. It defines content methodology as establishing objectives, KPIs, and a culture of continuous learning and iteration. An effective methodology focuses on connecting with audiences, creating optimal content, and optimizing processes. It also discusses why a methodology is needed due to the competitive landscape, proliferation of channels, and opportunities for improvement. Components of an effective methodology include defining objectives and KPIs, audience analysis, identifying opportunities, and evaluating resources. The document concludes with recommendations around creating a content plan, testing and optimizing content over 90 days.
How to Prepare For a Successful Job Search for 2024
How to Prepare For a Successful Job Search for 2024Albert Qian The document provides guidance on preparing a job search for 2024. It discusses the state of the job market, focusing on growth in AI and healthcare but also continued layoffs. It recommends figuring out what you want to do by researching interests and skills, then conducting informational interviews. The job search should involve building a personal brand on LinkedIn, actively applying to jobs, tailoring resumes and interviews, maintaining job hunting as a habit, and continuing self-improvement. Once hired, the document advises setting new goals and keeping skills and networking active in case of future opportunities.
Social Media Marketing Trends 2024 // The Global Indie Insights
Social Media Marketing Trends 2024 // The Global Indie InsightsKurio // The Social Media Age(ncy) The 2024 social media marketing trends report highlights significant shifts influenced by generative AI, including the emergence of personalized content, the rise of virtual influencers, and a stronger focus on user-generated content. Insights were gathered from 33 experts across 23 leading independent agencies, providing a perspective that emphasizes creativity and authenticity in marketing strategies. Key trends also include the blending of B2B and B2C approaches, reflecting changes in consumer behavior and the evolving landscape of social media engagement.
Trends In Paid Search: Navigating The Digital Landscape In 2024
Trends In Paid Search: Navigating The Digital Landscape In 2024Search Engine Journal The document discusses trends in paid search for 2024, highlighting changes in user behavior, the implications for financial services, and privacy challenges. It emphasizes the importance of adapting search strategies, utilizing AI-driven tools like performance max and smart bidding, and leveraging first-party data for better marketing efficacy. Key takeaways include holistic SEO and SEM approaches, monitoring shifting user intents, and the need for continuous performance evaluation.
5 Public speaking tips from TED - Visualized summary
5 Public speaking tips from TED - Visualized summarySpeakerHub The document outlines five public speaking tips from Chris Anderson, TED Talks curator, emphasizing the importance of eye contact, vulnerability, humor, humility, and storytelling. These skills are presented as essential for engaging audiences effectively and are increasingly valuable in today's economy. The article posits that mastering these techniques can enhance speakers' ability to communicate ideas powerfully.
ChatGPT and the Future of Work - Clark Boyd
ChatGPT and the Future of Work - Clark Boyd Clark Boyd The document provides an overview of generative AI, particularly focusing on ChatGPT and its implications for business and the job market. It discusses the rapid growth of generative AI, its applications in marketing, and the skills needed for the AI era while addressing potential job displacement and the need for adaptation. The agenda includes a Q&A session and emphasizes rethinking work in collaboration with AI technology.
Getting into the tech field. what next
Getting into the tech field. what next Tessa Mero The document provides career advice for getting into the tech field, including:
- Doing projects and internships in college to build a portfolio.
- Learning about different roles and technologies through industry research.
- Contributing to open source projects to build experience and network.
- Developing a personal brand through a website and social media presence.
- Networking through events, communities, and finding a mentor.
- Practicing interviews through mock interviews and whiteboarding coding questions.
Google's Just Not That Into You: Understanding Core Updates & Search Intent
Google's Just Not That Into You: Understanding Core Updates & Search IntentLily Ray 1. Core updates from Google periodically change how its algorithms assess and rank websites and pages. This can impact rankings through shifts in user intent, site quality issues being caught up to, world events influencing queries, and overhauls to search like the E-A-T framework.
2. There are many possible user intents beyond just transactional, navigational and informational. Identifying intent shifts is important during core updates. Sites may need to optimize for new intents through different content types and sections.
3. Responding effectively to core updates requires analyzing "before and after" data to understand changes, identifying new intents or page types, and ensuring content matches appropriate intents across video, images, knowledge graphs and more.
How to have difficult conversations
How to have difficult conversations Rajiv Jayarajah, MAppComm, ACC The document provides essential tips on how to handle difficult conversations in a workplace setting, emphasizing the importance of preparation, environment, and timing. It highlights that many employees dread such conversations, often leading to avoidance and worsening situations. Ultimately, the guide aims to promote positive outcomes while maintaining professional relationships.
Introduction to Data Science
Introduction to Data ScienceChristy Abraham Joy The document discusses the rise and importance of data science and machine learning, highlighting the growing demand for data scientists and the challenges they face. It explains machine learning concepts such as supervised and unsupervised learning, along with various real-world applications and the necessary steps involved in a machine learning workflow. Additionally, the document emphasizes the iterative process of model improvement and feature engineering used to enhance machine learning outcomes.
Time Management & Productivity - Best Practices
Time Management & Productivity - Best PracticesVit Horky The document outlines best practices for time management and productivity, focusing on effective meeting habits, structured work blocks, and the importance of reflection and goal setting. It emphasizes the need for proper planning, the use of appropriate tools, and prioritizing tasks to enhance both personal and team efficiency. Additionally, personal anecdotes and strategies are shared to encourage a positive mindset and enjoyment in achieving work-related goals.
The six step guide to practical project management
The six step guide to practical project managementMindGenius The document outlines a simplified six-step guide to project management designed for individuals lacking formal training. It emphasizes the importance of understanding project objectives, gathering stakeholder requirements, defining project scope, scheduling tasks, monitoring progress, and conducting a retrospective meeting. Additionally, it promotes the use of the MindGenius tool for effective project planning and execution.
Beginners Guide to TikTok for Search - Rachel Pearson - We are Tilt __ Bright...
Beginners Guide to TikTok for Search - Rachel Pearson - We are Tilt __ Bright...RachelPearson36 A presentation for absolute beginners who have never touched TikTok and may be a bit scared of it!
Unlocking the Power of ChatGPT and AI in Testing - A Real-World Look, present...
Unlocking the Power of ChatGPT and AI in Testing - A Real-World Look, present...Applitools The document discusses the application of ChatGPT and AI in software testing and programming, including its strengths and limitations. It covers ChatGPT's capabilities, such as code writing, refactoring, and debugging, and emphasizes the importance of human expertise in the software development life cycle. Additionally, it highlights various AI tools, potential pitfalls, and offers strategies for integrating AI into testing practices.
12 Ways to Increase Your Influence at Work
12 Ways to Increase Your Influence at WorkGetSmarter The document outlines strategies for increasing influence in the workplace, emphasizing the importance of setting clear goals, building trust, and demonstrating consistency in actions. It also highlights the significance of relationship building, proactivity, and self-awareness regarding influencing styles. Lastly, it underscores that true leadership is about impact, influence, and inspiration rather than titles.
ChatGPT webinar slides
ChatGPT webinar slidesAlireza Esmikhani The document discusses various AI tools from OpenAI like GPT-3 and DALL-E 2, as well as ChatGPT. It explores how search engines are using AI and things to consider around AI-generated content. Potential SEO uses of ChatGPT are also presented, such as generating content at scale, conducting topic research, and automating basic coding tasks. The document encourages further reading on using ChatGPT for SEO purposes.
Php documentor
- 2. 文件的重要 “Writing good documentation is essential to the success of any software project.”http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.pkg.html特別是 OOS 項目2011 Aircamel Copyright 2
- 3. 文件的類型Client User教學或使用文件開發人員案例：API文檔2011 Aircamel Copyright 3
- 6. ExamplePEAR API Documentationhttp://pear.php.net/package/Auth/docs/latest/Zend Frameworkhttp://framework.zend.com/apidoc/coresymfonyhttp://www.symfony-project.org/api/1_22011 Aircamel Copyright 6
- 7. How to InstallphpDocumentor的安裝分為自動安裝和手動安裝兩種方式通過pear 自動安裝pear install PhpDocumentor手動安裝在http://manual.phpdoc.org/下載最新版本的PhpDocumentor把內容解壓即可。 2011 Aircamel Copyright 7
- 8. 如何使用所有的註釋都是由/**開始的一個多行註釋，在phpDocumentor裡稱為DocBlock, DocBlock是指軟體開發人員編寫的關於某個關鍵字的幫助訊息，使得 其他人能夠通過它知道這個關鍵字的具體用途，如何運用 。PhpDocumentor規定 一個DocBlock包含如下訊息：功能簡述區 (Short Description)詳細說明區 (Long Description)標記tag 2011 Aircamel Copyright 8
- 9. DocBlock/*** Short description ** Long description. This is an sample function * to show the DocBlock format.** 2nd paragraph of long description. * * * @tag1 * @tag2 */2011 Aircamel Copyright 9
- 10. Short Description正文一般是簡明扼要地說明這個類別，方法或者 函數的功能。功能簡述的正文在生成的文檔中將顯示在索引區。功能描述區的內容可 以通過一個空行或者 */ 來 結束。2011 Aircamel Copyright 10
- 11. Long Description在功能描述區後是一個空行，接着是詳細說明區,這部分主要是詳細說明你的API的 功能，用途，如果可能，也可以有用法舉例等等。2011 Aircamel Copyright 11
- 12. Long Description/*** - unordered item A * - unordered item B * * 1 ordered item A * 2 ordered item B */2011 Aircamel Copyright 12
- 13. Long Description無長度限制可以多行一些HTML標籤使用 b, code, br, i, kbd, li, ol, p, pre, samp, ul, var2011 Aircamel Copyright 13
- 14. Tags位於Long Description 後一個空白行指明一些參數上的訊息，主要是參數類型回傳值類型繼承聯系2011 Aircamel Copyright 14
- 15. @author@author aurthorname<[email protected]>描述作者E - mail 可以怱略2011 Aircamel Copyright 15
- 16. @license顯示版權及 URL例：@license http://opensource.org/licenses/api/licenese.php GUN Public License2011 Aircamel Copyright 16@license authorname<[email protected]>
- 17. @package出此檔是屬於哪個 package ， package 的名字和程式沒有關係，可以自由指定。指定它的用途只是方便管理檔案，讓相關的檔案在產生的註解文件中可以放一起呈現。2011 Aircamel Copyright 17
- 18. @param變數及型態的說明PHP 內的類型提示(Type Hinting)例：@paramint $num@parambool|string $foo a bool or string param2011 Aircamel Copyright 18@paramdatatype$paramnamedescription
- 19. @return函數回傳表示回傳值的型態例：@return mixed@return fooClass|falsefooClass object or error2011 Aircamel Copyright 19@return datatypedescript
- 20. DocBlock Template解決當重覆的列出相同的變數與方法許多遍時，造成的不良這樣的情況叫DocBlock Template2011 Aircamel Copyright 20
- 21. DocBlock Template/**#@+* @access private* @var string*/var $_var1 = ‘Hello’;var $_var2 = ‘World’;...var $_varN;/**#@-*///下面的說明，不適用var $varX = array();2011 Aircamel Copyright 21
- 22. 說明檔的產生phpdoc-o HTML:frames:earthli -f sample1.php -t docs2011 Aircamel Copyright 22
- 23. Option-d：指定的產生目錄中的代碼-t ：指定目標的文件-o：輸出格式，指定模板2011 Aircamel Copyright 23
- 24. Template你可以自己/選擇輸出格式HTML - SmartCHM - Windows help 的模板可PDF - Adobe Acrobat 形式XML：DocBook的 - 可重複使用為出發2011 Aircamel Copyright 24
- 25. PHPDocument是從你原始碼的註釋中生成文檔，因此在在你程式中做註釋的流程 ，也就是你編製文檔的流程 。促使養成良好的編程習慣，盡量運用規範，清晰的文字為程式做註釋，同時多多少少也防止 了事後編製文檔和文檔的更新不同步的一些問題。2011 Aircamel Copyright 25