如何使用phpDocumentor、教程/扩展文档编写代码块?
如何在编写教程/扩展文档时使用phpDocumentor编写代码块 我尝试了如何使用phpDocumentor、教程/扩展文档编写代码块?,php,external,phpdoc,Php,External,Phpdoc,如何在编写教程/扩展文档时使用phpDocumentor编写代码块 我尝试了,它可以生成标记,但它不解析其内容 <refentry id="{@id}"> <refnamediv> <refname>Guide for MyApp</refname> <refpurpose>To demonstrate ...</refpurpose> </refnamediv> <r
,它可以生成
标记,但它不解析其内容
<refentry id="{@id}">
<refnamediv>
<refname>Guide for MyApp</refname>
<refpurpose>To demonstrate ...</refpurpose>
</refnamediv>
<refsynopsisdiv>
<author>
My Name
<authorblurb>
{@link mail@mail.com My Name}
</authorblurb>
</author>
</refsynopsisdiv>
{@toc}
<refsect1 id="{@id intro}">
<title>User Guide for MyApp</title>
<para>
Some Description
</para>
<programlisting>
$some = 'code';
</programlisting>
</refsect1>
</refentry>
MyApp指南
证明。。。
我的名字
{@linkmail@mail.com我的名字}
{@toc}
MyApp用户指南
一些描述
$some='code';
我检查了它,我认为您可以使用javascriptMVC文档工具。我想。还有一个演示。我建议你试试这个 这是javascriptMVC的documentJs输出,我想这是你想要的。或者至少我希望如此。(-:
关于phpDocumentor,正如我说的,我需要一些解释来理解你的意思,但现在请检查这些。 (如果以下是您想要的) 或: 另一个例子是显式地在foreach中记录变量;许多ide使用此信息来帮助您自动完成:
/** @type \Sqlite3 $sqlite */
foreach($connections as $sqlite) {
// there should be no docblock here
$sqlite->open('/my/database/path');
<...>
}
/**@type\Sqlite3$sqlite*/
foreach($sqlite形式的连接){
//这里不应该有docblock
$sqlite->open('/my/database/path');
}
您可以使用zend studio工具,该工具可以自动生成选定的项目文档一旦您知道如何操作,这实际上非常简单。您只需在程序列表
元素上设置角色
属性
<programlisting role="php">
$some = 'code';
</programlisting>
还要注意的是,所有这些都适用于phpDocumentor的初始版本就我所知,它似乎不支持教程/扩展文档。你能在你的问题中编辑一个你尝试过的例子吗?你的意思是在函数/方法之前的注释块中吗?没有人,这不是关于函数之前的注释块,而是关于编写教程/扩展文档。这是不同的。我不知道需要javascript文档,标题是phpDocumentator。@Antiator好的,给我一些时间。@Antiator好的,你能解释一下你的意思吗?伙计,我真的很感谢你的帮助,但我认为你走错了方向。我知道如何编写标准注释块。我不知道的是如何编写编写扩展文档时编写示例代码(包含代码的注释)。因此,您应该首先关注扩展文档(也称为教程)的含义。以及解析其内容的含义:PhpDocumentator应该能够“理解”注释(识别PHP语言),并以不同的颜色显示代码。例如:单词“class”应以蓝色显示。这里有一个链接,可以查看我在说什么nx,这正是我一直要求的。
/** @type \Sqlite3 $sqlite */
foreach($connections as $sqlite) {
// there should be no docblock here
$sqlite->open('/my/database/path');
<...>
}
<programlisting role="php">
$some = 'code';
</programlisting>
<programlisting role="html">
<![CDATA[
<b>This sentence will be bold.</b>
]]>
</programlisting>