Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
<?xml version="1.0" encoding="UTF-8" ?>
<phpdocumentor
configVersion="3"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="https://www.phpdoc.org">
<!-- 文件標題 -->
<title>API 文件</title>
<paths>
<!-- 文件和快取路徑,以該檔案位置為基準 -->
<output>docs/Document</output>
<cache>docs/.cache</cache>
</paths>
<version number="1.0.0">
<api format="php">
<!-- dsn 可設定相對路徑或絕對路徑,以該檔案位置為基準,我是把這個設定檔案放在根目錄外面 -->
<source dsn="./www/app/Controllers/">
<!-- 這裡的路徑建議設定嚴謹的路徑,避免不必要的 class 露出 -->
<path>*.php</path>
</source>
<markers>
<!-- 看想要哪些 markers 被寫出來 -->
<marker>TODO</marker>
<marker>FIXME</marker>
</markers>
<!-- 不同的 package 可以標記不同,選一個主要 package 設定一樣的就行 -->
<default-package-name>API</default-package-name>
<!-- 只顯示 public 的方法或成員,推薦內部的方法或成員標記 @internal -->
<visibilities>
<visibility>public</visibility>
</visibilities>
</api>
</version>
</phpdocumentor>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment