1<?xml version="1.0" encoding="UTF-8"?> 2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> 3<html xmlns="http://www.w3.org/1999/xhtml" lang="zh-cn" xml:lang="zh-cn"><head><!-- 4 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX 5 This file is generated from xml source: DO NOT EDIT 6 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX 7 --> 8<title>Apache 2.0 文档 - Apache HTTP 服务器</title> 9<link href="/style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" /> 10<link href="/style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" /> 11<link href="/style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link rel="stylesheet" type="text/css" href="/style/css/prettify.css" /> 12<script src="/style/scripts/prettify.min.js" type="text/javascript"> 13</script> 14 15<link href="/images/favicon.ico" rel="shortcut icon" /></head> 16<body id="manual-page" class="no-sidebar"><div id="page-header"> 17<p class="menu"><a href="/mod/">模块</a> | <a href="/mod/directives.html">指令</a> | <a href="http://wiki.apache.org/httpd/FAQ">常见问题</a> | <a href="/glossary.html">术语</a> | <a href="/sitemap.html">网站导航</a></p> 18<p class="apache">Apache HTTP 服务器版本 2.4</p> 19<img alt="" src="/images/feather.gif" /></div> 20<div class="up"><a href="./"><img title="<-" alt="<-" src="/images/left.gif" /></a></div> 21<div id="path"> 22<a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP 服务器</a> > <a href="http://httpd.apache.org/docs/">文档</a> > <a href="../">版本 2.4</a> > <a href="./">开发者文档</a></div><div id="page-content"><div id="preamble"><h1>Apache 2.0 文档</h1> 23<div class="toplang"> 24<p><span>可用语言: </span><a href="/en/developer/documenting.html" hreflang="en" rel="alternate" title="English"> en </a> | 25<a href="/zh-cn/developer/documenting.html" title="Simplified Chinese"> zh-cn </a></p> 26</div> 27<div class="outofdate">此翻译可能过期。要了解最近的更改，请阅读英文版。</div> 28 29 <p>Apache 2.0 使用 <a href="http://www.doxygen.org/">Doxygen</a> 从代码中 30 生成 API 和全局变量的文档。下面是对使用 Doxygen 生成文档的简介。</p> 31</div> 32<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div> 33<div class="section"> 34<h2><a name="brief" id="brief">简要说明</a></h2> 35 <p>使用 <code>/**</code> 开始文档块<br /> 36 使用 <code>*/</code> 结束文档块</p> 37 38 <p>在文档块中，我们可以使用多个标签:</p> 39 40 <div class="example"><p><code> 41 Description of this functions purpose<br /> 42 @param parameter_name description<br /> 43 @return description<br /> 44 @deffunc signature of the function<br /> 45 </code></p></div> 46 47 <p>一般不需要 <code>deffunc</code> 。DoxyGen 没有完整的解析器，所以任何 48 在返回类型声明中使用宏的原型，都是太复杂了。这些函数就需要使用 <code>deffunc</code>。 49 例如 (使用 &gt; 而不是 >):</p> 50 51 <div class="example"><p><code> 52 /**<br /> 53 * return the final element of the pathname<br /> 54 * @param pathname The path to get the final element of<br /> 55 * @return the final element of the path<br /> 56 * @tip Examples:<br /> 57 * <pre><br /> 58 * "/foo/bar/gum" -&gt; "gum"<br /> 59 * "/foo/bar/gum/" -&gt; ""<br /> 60 * "gum" -&gt; "gum"<br /> 61 * "wi\\n32\\stuff" -&gt; "stuff"<br /> 62 * </pre><br /> 63 * @deffunc const char * ap_filename_of_pathname(const char *pathname)<br /> 64 */ 65 </code></p></div> 66 67 <p>总是在头文件开始包含:</p> 68 <div class="example"><p><code> 69 /**<br /> 70 * @package Name of library header<br /> 71 */ 72 </code></p></div> 73 74 <p>Doxygen 为每个包生成一个新的 HTML 文件，名字是 75 {Name_of_library_header}.html，所以请简化名称。</p> 76 77 <p>更深入的讨论，请参见 78 <a href="http://www.doxygen.org/">Doxygen 站点</a>。</p> 79</div></div> 80<div class="bottomlang"> 81<p><span>可用语言: </span><a href="/en/developer/documenting.html" hreflang="en" rel="alternate" title="English"> en </a> | 82<a href="/zh-cn/developer/documenting.html" title="Simplified Chinese"> zh-cn </a></p> 83</div><div class="top"><a href="#page-header"><img src="/images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">评论</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div> 84<script type="text/javascript"><!--//--><![CDATA[//><!-- 85var comments_shortname = 'httpd'; 86var comments_identifier = 'http://httpd.apache.org/docs/2.4/developer/documenting.html'; 87(function(w, d) { 88 if (w.location.hostname.toLowerCase() == "httpd.apache.org") { 89 d.write('<div id="comments_thread"><\/div>'); 90 var s = d.createElement('script'); 91 s.type = 'text/javascript'; 92 s.async = true; 93 s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier; 94 (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s); 95 } 96 else { 97 d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>'); 98 } 99})(window, document); 100//--><!]]></script></div><div id="footer"> 101<p class="apache">Copyright 2014 The Apache Software Foundation.<br />基于 <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a> 许可证.</p> 102<p class="menu"><a href="/mod/">模块</a> | <a href="/mod/directives.html">指令</a> | <a href="http://wiki.apache.org/httpd/FAQ">常见问题</a> | <a href="/glossary.html">术语</a> | <a href="/sitemap.html">网站导航</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!-- 103if (typeof(prettyPrint) !== 'undefined') { 104 prettyPrint(); 105} 106//--><!]]></script> 107</body></html>
