濡備綍涓洪」鐩啓鏂囨。銆佺敤浠€涔堝啓鏂囨。銆佸浣曟柟渚跨殑綆＄悊/鏇存柊鏂囨。錛岃繖鏄緢澶氭妧鏈漢鍛橀兘瑕佺粡甯擱潰瀵圭殑涓€浜涢棶棰樸€傛牴鎹釜浜虹粡楠岋紝紼嬪簭寮€鍙戠被宸ヤ綔涓垜浠秹鍙?qiáng)鍒扮殑鏂囨。鍙兘涓昏鍖呮嫭涓嬮潰鍑牼c伙紝
- 鍑芥暟/綾葷殑鎺ュ彛璇存槑鏂囨。錛?姣斿 XXX Framework API Documentation
- 鏈嶅姟绔帴鍙ｈ鏄庢枃?。锛屾瘮濡?Web Service API, Restful API 絳?/li>
- 浣跨敤鎸囧崡銆佹墜鍐岀瓑璇存槑鏂囨。錛屾瘮濡?Getting Start XXX, XXX Tutorial, XXX Guideline, XXX Manual 絳?/li>
- 璁捐鐩稿叧鏂囨。錛屾瘮濡?鏁版嵁搴?ER 鍥俱€佺被鍥俱€佹椂搴忓浘絳夛紙Enterprise Architect錛?/li>
鐩稿叧宸ュ叿/騫沖彴
涓嬮潰錛屾垜浠皢鍒嗗埆浠嬬粛涓€浜涘父鐢ㄧ殑鐩稿叧宸ュ叿/騫沖彴
浣跨敤鎸囧崡銆佹墜鍐岀瓑璇存槑鏂囨。
姝ょ被鏂囨。鍐呭澶氫互澶ф鏂囧瓧璇存槑涓轟富錛屼竴鑸寜绔犺妭榪涜鍐呭緇勭粐錛岄殢鐫€欏圭洰鐨勪笉鏂垚鐔熴€佹紨榪涳紝寰堝鎴愮啛欏圭洰鐨勬枃?。閮戒?xì)鏈夌浉褰摻媷骞呭Q涗簬姝ゅ悓鏃訛紝鍑轟簬鏍煎紡銆佹帓鐗堢瓑闇€姹傦紝閫愭褰㈡垚浜?jiǎn)澶毧U嶆爣璁拌璦€鏍囧噯錛屽父瑙佺殑姣斿 TeX, DocBook, Markdown, reStructuredText, AsciiDoc 絳夈€傜洰鍓嶄簰鑱旂綉欏圭洰涓富瑕佹祦琛?Markdown, reStructuredText, AsciiDoc 絳夎交閲忕駭鏍囪璇█錛孴ex銆丏ocBook 榪囦簬澶嶆潅錛宺eStructuredText 涓昏鍦?Python 寮€鍙戣€呬腑嫻佽錛孫rg-mode 涓昏浠?Emacs 鐢ㄦ埛涓轟富錛孧arkdown 鏈€涓烘祦琛岋紙鐢變簬 Markdown 榪囦簬綆€鍗曪紝鐩墠鍑犲ぇ緇勭粐/鍏徃鍒嗗埆瀹氫箟浜?jiǎn)鑷忿q殑 Markdown 鎵╁睍璇硶錛屾瘮濡?GitHub Flavored Markdown錛孧ultiMarkdown錛孧arkdown Extra錛孭andoc Markdown 絳夛級(jí)銆?/p>
鎵╁睍闃呰錛?/p>
ReST錛坮eStructuredText錛?/h4>
- Sphinx Documentation錛屽彲鑳芥槸 ReST錛坮eStructuredText錛?緋葷殑浠ｈ〃欏圭洰浜?jiǎn)鍚уQ孭ython 寮€鍙戯紝鐢變簬璇硶綆€鍗曘€佸姛鑳藉己澶э紝闈炲父澶氱殑欏圭洰閮戒嬌鐢?Sphinx 鏉ョ敓鎴愰」鐩枃?。锛?a rel="nofollow" >鎰熷彈涓?錛夛紝璺熶粬涓€璧峰嚭鐜扮殑榪樻湁 Read The Docs錛堝紑婧愭枃?。鐢熸垚鐨勬墭绠◎q沖彴鍜岀ぞ鍖猴紝鍚屾椂鏀寔 reStructuredText 鏍煎紡浠ュ強(qiáng) Markdown 鏍煎紡錛?榪欎綅鍏勫紵錛屽叧浜庝粬浠箣闂寸殑鍏崇郴錛屽彲浠?a rel="nofollow" >鐪嬩笅榪欓噷錛涚浉鍏?PHP 欏圭洰紺轟緥錛?
Markdown
鐢變簬 Markdown 綆€鍗曟槗璇伙紝鍙渶瑕佹櫘閫氱殑鏂囨湰緙栬緫鍣ㄥ氨鑳藉緙栬緫錛岃娉曟洿鏄畝鍗曞埌姣忎釜浜洪兘鍙互鍦ㄦ暟鍒嗛挓鍐呭浼?xì)锛屽洜姝ゅQ屼綔涓轟竴闂?2004 騫存墠琚彂鏄庡嚭鏉ョ殑杞婚噺綰ф爣璁拌璦€錛孧arkdown 寰堝揩渚垮緱鍒頒簡(jiǎn)璇稿 Github錛?a rel="nofollow" >reddit, Stack Exchange, Bitbucket 絳夊ぇ閲忕綉绔欑殑鏀寔銆傝€屼即闅忕潃 Github 鏃嬮妯壂鏁翠釜寮€婧愮晫錛?git + Github + Markdown + Jekyll 緇勫悎鏇存槸鎴愪負(fù)浜掕仈緗戞椂浠ｅぇ閲忕鎶€鍐欎綔鑰呯敋鑷沖皬閮ㄥ垎鏂囪壓闈掑勾鐨勪富鍔涚敓浜у姏騫沖彴銆?/p>
- Jekyll - 涓嶄粎浠呭彲浠ョ敓鎴愰潤(rùn)鎬佸崥瀹㈢珯鐐癸紝Jekyll 鍚屾牱閫傜敤浜庢枃?。鍐呭鐢熸垚锛學(xué)ista錛堜竴瀹朵紒涓氳棰戞墭綆℃湇鍔℃彁渚涘晢錛?a rel="nofollow" >鍦ㄨ繖閲?/a>鍒嗕韓浜?jiǎn)浠栦滑鍩轰?Jekyll 鐨勬枃妗ｇ鐞嗙粡楠岋紝浣犲彲浠?a rel="nofollow" >鐐硅繖閲屽厛鐫逛負(fù)蹇?/a>錛?a rel="nofollow" >婧愮爜錛夈€備笅闈㈠垪涓句簡(jiǎn) Jekyll 鏂囨。鍏朵粬鐩稿叧涓婚錛?
- MkDocs - 鏍規(guī)嵁 Markdown 鏂囨。鐢熸垚闈?rùn)鎬佺綉绔欙紝Python 璇█寮€鍙戯紝
- GitBook - 闄や簡(jiǎn) Markdown錛孏itBook 榪樻敮鎸佸彟澶栦竴縐嶄笌 Markdown 寰堢被浼間絾鍔熻兘鏇翠赴瀵岀殑鏍囪璇█ AsciiDoc錛汫itBook 闄や簡(jiǎn)鎻愪緵鍩轟簬 node.js 寮€鍙戠殑鍙緵鏈湴榪愯鐨勫懡浠よ鐗堟湰澶栵紝榪樻彁渚涗簡(jiǎn)鍦ㄧ嚎鎵樼鏈嶅姟銆?
- Peach - 鍥戒漢鍩轟簬 Go 璇█寮€鍙戠殑涓€嬈炬敮鎸佸璇█銆佸疄鏃跺悓姝ヤ互鍙?qiáng)鍏ㄦ枃鎼滅储鍔熻兘鐨?Web 鏂囨。鏈嶅姟鍣ㄣ€傝禐涓€涓獈錛屼嬌鐢ㄧず渚嬶紝
- Peach 鏂囨。 - Peach 瀹樻柟鏂囨。
- Gogs 鏂囨。 - 鍥戒漢鍩轟簬 Go 璇█寮€鍙戠殑綾?Gitlab 鏈嶅姟鍣紝鐣岄潰姣旇緝?yōu)畯娓呮柊鍝
涓嬮潰鐨勮〃鏍煎姣斾簡(jiǎn)鍑犳鏀寔 Markdown 鐨勪富嫻佹枃?。宸ュ叿涔嬮棿涓昏鐗规€х殑鍖哄埆錛堝疄闄呭尯鍒彲鑳戒笌鎴戞墍鐞嗚В鐨勬湁鍋忓樊錛夛細(xì)
| 鍚嶇О |
鑷姪鎵樼---- |
澶氳璦€鏂囨。 |
瀹炴椂鍚屾 |
闈?rùn)鎬?HTML |
澶氱増鏈?/th>
|
| Read The Docs |
鉁?/td>
| 鉁?/td>
| 鉁?/td>
| 鉁?/td>
| 鉁?/td>
|
| Peach |
鉁?/td>
| 鉁?/td>
| 鉁?/td>
| 鉁擄紙鍙紦瀛橈級(jí) |
璁″垝涓?/a> |
| Mkdocs |
鉁?/td>
| 鉁?/td>
| 鉁?/td>
| 鉁?/td>
| 鉁?/td>
|
| GitBook |
鉁?/td>
| 鉁?/td>
| 鉁?/td>
| 鉁?/td>
| 鉁?/td>
|
| Jekyll |
鉁?/td>
| 鉁擄紙鎻掍歡錛?/td>
| 鉁?/td>
| 鉁?/td>
| 鉁擄紙涓嶅畬緹庯級(jí) |
AsciiDoc
AsciiDoc 鏈€鍒濆熀浜?Python 寮€鍙戯紝鍏跺熀鏈娉曡窡 Markdown 綾諱技錛屼緥濡備互 = 寮€澶翠綔涓烘爣棰樸€佷互 * 鍙峰紑澶翠綔涓哄垪琛ㄩ」絳夛紝璇︾粏鐨勮娉曡鏄庡彲浠?a rel="nofollow" >鐪嬭繖閲?/a>錛屼絾 AsciiDoc 姣?Markdown 鏀寔鏇村鐨勬牸寮忥紝姣斿琛ㄦ牸銆佹枃浠跺寘鍚瓑錛屽悓鏃?AsciiDoc 鏄?O'Reilly 鐨?Atlas 鍦ㄧ嚎鍑虹増騫沖彴 鐨勬帹鑽愯璦€錛岀浉褰撳ぇ閮ㄥ垎鐨?Git 瀹樻柟鏂囨。閮戒嬌鐢ㄤ簡(jiǎn) AsciiDoc 鏍煎紡銆?/p>
鎵╁睍闃呰錛?/p>
DocBook
- DocBook 姣?HTML 璇█榪樻棭涓€騫達(dá)紙1992 騫達(dá)級(jí)鍑虹幇鐨?XML 緋繪爣璁拌璦€錛屽彲浠ラ潪甯告柟渚跨殑鐢熸垚鍏朵粬鏂囦歡鏍煎紡錛屾瘮濡?HTMl銆丳DF銆丆HM 絳夛紝寮€婧愮晫浣跨敤 DocBook 鐨勯」鐩潪甯稿錛屾瘮濡傚ぇ瀹惰€崇啛鑳借鐨勪竴浜涢」鐩紝Linux Kernel銆?a rel="nofollow" >FreeBSD銆?a rel="nofollow" >PostgreSQL銆?a rel="nofollow" Reilly Media銆?a rel="nofollow" >OpenStack錛?a rel="nofollow" >PHP 鐨勫畼鏂規(guī)枃妗?/a>涔熺敤鐨勫畠鍝︼紝鏇村欏圭洰鍜岀粍緇囧垪琛ㄥ彲浠?a rel="nofollow" >鐪嬭繖閲?/a>錛涗笉榪囩函 PHP 鐩稿叧欏圭洰浣跨敤 Docbook 鐨勮緝?yōu)畱锛屾瘯绔熶娇鐢?XML 鏉ュ啓鏂囨。闂ㄦ鏈夌偣楂?:sunglasses:錛岄」鐩ず渚嬶紝
Tex
Tex 鏄敱 Donald Knuth 鍒涢€犵殑鍩轟簬浣庣駭緙栫▼璇█鐨勭數(shù)瀛愭帓鐗堢郴緇燂紝鍒╃敤 TeX 鑳藉瀵規(guī)枃绔犺繘琛屽崄鍒嗙簿緹庣殑鎺掔増錛孴eX 鎻愪緵浜?jiǎn)涓€濂楀姛鑳藉己澶у茍涓斿崄鍒嗙伒媧葷殑鎺掔増璇█錛屽悓鏃?TeX 緋葷粺鏄叕璁ょ殑鏁板鍏紡鎺掑緱鏈€濂界殑緋葷粺銆?/p>
- LaTeX - LaTeX錛堝彂闊充負(fù)鈥淟ah-tech鈥濇垨鈥淟ay-tech鈥濓級(jí)鏄敱 Leslie Lamport 寮€鍙戠殑褰撲粖涓栫晫涓婃渶嫻佽鍜屼嬌鐢ㄦ渶涓哄箍娉涚殑TeX瀹忛泦銆?鎶?LaTeX 鏀懼埌鏈€鍚庢槸鐢變簬 TeX 璇硶鐨勯珮闂ㄦ錛屽鑷撮櫎浜?jiǎn)涓撲笟鐨効U戝鐮旂┒銆佸嚭鐗堥鍩燂紝闄や簡(jiǎn)鎴戜滑鏁話(huà)鐨勯偅浜涘ぇ紲炰滑錛屽湪鍋忓伐紼?搴旂敤綾葷殑鏅€氱爜鍐滅晫涓病鏈夌湡姝ｅぇ瑙勬ā嫻佽寮€鏉ャ€?/li>
鍑芥暟/綾葷殑鎺ュ彛璇存槑鏂囨。
- PHPDoc錛屽啓 PHP 鐨勯兘搴旇鐭ラ亾榪欎釜鍝堬紝鍢垮樋銆傜ず渚嬶紝
- Sami錛孲ymfony 妗嗘灦浣跨敤鐨勬枃?。鐢熸垚宸ュ咗P紝紺轟緥錛?
- Doxygen錛岃秴綰ц€佺墝鏂囨。鐢熸垚宸ュ叿浜?jiǎn)锛岄櫎浜?jiǎn) PHP 澶栬繕鏀寔鍏朵粬 N 縐嶇紪紼嬭璦€
- phpDox
- Apigen
鏈嶅姟绔帴鍙ｈ鏄庢枃妗?/h3>
璁捐鐩稿叧鏂囨。
