国产精品嫩草99av在线_一区在线视频观看_欧美高清一区_欧美 日韩 国产 一区_99精品欧美一区二区三区_久久大香伊蕉在人线观看热2_一色屋精品视频在线观看网站_在线亚洲国产精品网站_亚洲区一区二区三区_你懂的视频一区二区

當(dāng)前位置:首頁(yè) > 科技  > 軟件

你喜歡哪種文檔標(biāo)記語(yǔ)言?

來(lái)源: 責(zé)編: 時(shí)間:2023-08-09 23:02:52 412觀看
導(dǎo)讀文檔很重要,而易讀的文檔更重要。在開(kāi)源軟件世界中,文檔可以告訴我們?nèi)绾问褂没蜇暙I(xiàn)一個(gè)應(yīng)用程序,就像 游戲 的規(guī)則書一樣。有很多不同類型的文檔:教程操作指南參考指南軟件架構(gòu)產(chǎn)品手冊(cè)我們向一些貢獻(xiàn)者詢問(wèn)了他們的技術(shù)

ERf28資訊網(wǎng)——每日最新資訊28at.com

文檔很重要,而易讀的文檔更重要。在開(kāi)源軟件世界中,文檔可以告訴我們?nèi)绾问褂没蜇暙I(xiàn)一個(gè)應(yīng)用程序,就像 游戲 的規(guī)則書一樣。ERf28資訊網(wǎng)——每日最新資訊28at.com

有很多不同類型的文檔:ERf28資訊網(wǎng)——每日最新資訊28at.com

  • 教程
  • 操作指南
  • 參考指南
  • 軟件架構(gòu)
  • 產(chǎn)品手冊(cè)

我們向一些貢獻(xiàn)者詢問(wèn)了他們的技術(shù)文檔工作流程,他們更喜歡使用哪種標(biāo)記語(yǔ)言,以及為什么會(huì)選擇其中一種。以下是他們的回答。ERf28資訊網(wǎng)——每日最新資訊28at.com

AsciiDoc

過(guò)去幾年中,Markdown 一直是我的標(biāo)準(zhǔn)語(yǔ)言。但最近我決定嘗試一下 AsciiDoc 。這種語(yǔ)法并不難,我在 Linux 桌面上的 Gedit 就支持它。我計(jì)劃暫時(shí)堅(jiān)持使用它一段時(shí)間。ERf28資訊網(wǎng)——每日最新資訊28at.com

—- Alan Formy-DuvalERf28資訊網(wǎng)——每日最新資訊28at.com

就低語(yǔ)法標(biāo)記語(yǔ)言而言,我更喜歡 AsciiDoc。我喜歡它,是因?yàn)槠滢D(zhuǎn)換過(guò)程一致且可預(yù)測(cè),沒(méi)有令人困惑的“口味”變化 。我還喜歡將它輸出為 Docbook,這是一種我信任其持久性和靈活性的標(biāo)記語(yǔ)言,它有大量的語(yǔ)法標(biāo)記。ERf28資訊網(wǎng)——每日最新資訊28at.com

但“正確”的選擇往往取決于項(xiàng)目已經(jīng)在使用什么。如果項(xiàng)目使用某種口味的 Markdown,我就不會(huì)使用 AsciiDoc。嗯,公平地說(shuō),我可能會(huì)使用 AsciiDoc,然后使用 Pandoc 將其轉(zhuǎn)換為草莓味的 Markdown。ERf28資訊網(wǎng)——每日最新資訊28at.com

當(dāng)然,我認(rèn)為 Markdown 有其應(yīng)用的時(shí)間和場(chǎng)合。我發(fā)現(xiàn)它比 AsciiDoc 更易讀。AsciiDoc 中的鏈接是這樣:ERf28資訊網(wǎng)——每日最新資訊28at.com

http://example.com [Example website]

而 Markdown 中的鏈接是這樣:ERf28資訊網(wǎng)——每日最新資訊28at.com

[Example.com](http://example.com)

Markdown 的語(yǔ)法直觀,以讀取 HTML 的方式呈現(xiàn)信息,大多數(shù)人都以相同的方式解析此類數(shù)據(jù)(“Example website……哦,那是藍(lán)色的文本,我將懸停一下以查看它指向哪里……它指向 example.com”)。ERf28資訊網(wǎng)——每日最新資訊28at.com

換句話說(shuō),當(dāng)我的受眾是人類讀者時(shí),我通常會(huì)選擇 Markdown,因?yàn)樗恼Z(yǔ)法簡(jiǎn)單,但仍具有足夠的語(yǔ)法可以進(jìn)行轉(zhuǎn)換,因此仍然是一種可接受的存儲(chǔ)格式。ERf28資訊網(wǎng)——每日最新資訊28at.com

雖然像 AsciiDoc 這樣簡(jiǎn)潔的語(yǔ)法看起來(lái)更令人吃驚,但如果我的受眾是要解析文件的計(jì)算機(jī),我會(huì)選擇 AsciiDoc。ERf28資訊網(wǎng)——每日最新資訊28at.com

—- Seth KenlonERf28資訊網(wǎng)——每日最新資訊28at.com

reStructuredText

我是 代碼即文檔 的忠實(shí)支持者,它將開(kāi)發(fā)者工具融入到內(nèi)容流程中。這樣可以更輕松地進(jìn)行高效的審查和協(xié)作,尤其是如果工程師是貢獻(xiàn)者。ERf28資訊網(wǎng)——每日最新資訊28at.com

作為一個(gè)標(biāo)記語(yǔ)言的行家,我在 O'Reilly 寫了整整一本關(guān)于 AsciiDoc 的書,還使用 Markdown 在各個(gè)平臺(tái)上發(fā)布了上千篇博文。但目前,我轉(zhuǎn)向使用 reStructuredText,并維護(hù)一些相關(guān)工具。ERf28資訊網(wǎng)——每日最新資訊28at.com

—— Lorna MitchellERf28資訊網(wǎng)——每日最新資訊28at.com

不得不提到 reStructuredText。在我大量使用 Python 編程時(shí),它已成為我的首選。它也是 Python 長(zhǎng)期以來(lái)用于文檔源碼和代碼注釋的標(biāo)準(zhǔn)。ERf28資訊網(wǎng)——每日最新資訊28at.com

與 Markdown 相比,我喜歡它不會(huì)受到非標(biāo)準(zhǔn)規(guī)范的困擾。話雖如此,當(dāng)我處理更復(fù)雜的文檔時(shí),確實(shí)還得使用許多 Sphinx 的功能和擴(kuò)展。ERf28資訊網(wǎng)——每日最新資訊28at.com

—— Jeremy StanleyERf28資訊網(wǎng)——每日最新資訊28at.com

HTML

能不用標(biāo)記語(yǔ)言我就不用。ERf28資訊網(wǎng)——每日最新資訊28at.com

不過(guò),我發(fā)現(xiàn) HTML 比其他標(biāo)記語(yǔ)言更易于使用。ERf28資訊網(wǎng)——每日最新資訊28at.com

—— Rikard Grossman-NielsenERf28資訊網(wǎng)——每日最新資訊28at.com

對(duì)我來(lái)說(shuō),撰寫文檔有各種方式。這取決于文檔將要放在何處,是作為網(wǎng)站的一部分、軟件包的一部分,還是可下載的內(nèi)容。ERf28資訊網(wǎng)——每日最新資訊28at.com

對(duì)于 Scribus 來(lái)說(shuō),其內(nèi)部文檔采用 HTML 格式,因?yàn)樾枰褂脙?nèi)部瀏覽器來(lái)訪問(wèn)。對(duì)于網(wǎng)站,可能需要使用維基語(yǔ)言。而對(duì)于可下載的內(nèi)容,可以創(chuàng)建 PDF 或 EPUB 格式。ERf28資訊網(wǎng)——每日最新資訊28at.com

我傾向于在純文本編輯器中編寫文檔。我可能會(huì)使用 XHTML,以便將這些文件導(dǎo)入到像 Sigil 這樣的 EPUB 制作工具中。當(dāng)然,對(duì)于創(chuàng)建 PDF,我會(huì)使用 Scribus,雖然我可能會(huì)導(dǎo)入用文本編輯器創(chuàng)建的文本文件。Scribus 具有包含圖形并精確控制其布局的優(yōu)勢(shì)。ERf28資訊網(wǎng)——每日最新資訊28at.com

Markdown 從未吸引我,我也從未嘗試過(guò) AsciiDoc。ERf28資訊網(wǎng)——每日最新資訊28at.com

—— Greg PittmanERf28資訊網(wǎng)——每日最新資訊28at.com

我目前正在使用 HTML 撰寫大量文檔,所以我要為 HTML 代言一下。你可以使用 HTML 創(chuàng)建網(wǎng)站或創(chuàng)建文檔。請(qǐng)注意,這兩者實(shí)際上并不相同 —— 當(dāng)你創(chuàng)建網(wǎng)站時(shí),大多數(shù)設(shè)計(jì)師關(guān)注的是呈現(xiàn)。但是當(dāng)你編寫文檔時(shí),技術(shù)作者應(yīng)該專注于內(nèi)容。ERf28資訊網(wǎng)——每日最新資訊28at.com

當(dāng)我用 HTML 撰寫文檔時(shí),我遵循 HTML 定義的標(biāo)簽和元素,并不關(guān)心它的外觀。換句話說(shuō),我用“未經(jīng)樣式化”的 HTML 編寫文檔。稍后我總是可以添加樣式表。因此,如果我需要強(qiáng)調(diào)文本的某一部分(比如警告),或者給單詞或短語(yǔ)加重語(yǔ)氣,我可能會(huì)使用 <strong> 和 <em> 標(biāo)簽,像這樣:ERf28資訊網(wǎng)——每日最新資訊28at.com

<p><strong>警告:激光!</strong>不要用你剩下的那只眼睛看向激光。</p>

或者在段落中提供一個(gè)簡(jiǎn)短的代碼示例,我可能會(huì)這樣寫:ERf28資訊網(wǎng)——每日最新資訊28at.com

<p><code>puts</code> 函數(shù)將一些文本輸出給用戶。</p>

要在文檔中格式化一段代碼塊,我使用 <pre><code>..</code></pre>,如下所示:ERf28資訊網(wǎng)——每日最新資訊28at.com

voidprint_array(int *array, int size){  for (int i = 0; i < size; i++) {    printf("array[%d] = %d/n", i, array[i]);  }}

HTML 的好處在于你可以立即在任何 Web 瀏覽器中查看結(jié)果。而你使用未經(jīng)樣式化的 HTML 編寫的任何文檔都可以通過(guò)添加樣式表來(lái)美化。ERf28資訊網(wǎng)——每日最新資訊28at.com

—— Jim HallERf28資訊網(wǎng)——每日最新資訊28at.com

意料之外的答案:LibreOffice

在上世紀(jì) 80/90 年代,當(dāng)我在 System V Unix、SunOS,最后是 Solaris 上工作時(shí),我使用了 nrofftroff 和最終的 groff 與 mm 宏。你可以了解一下使用 groff_mm 的 MM(前提是你已經(jīng)安裝了它們)。ERf28資訊網(wǎng)——每日最新資訊28at.com

MM 并不是真正的標(biāo)記語(yǔ)言,但它感覺(jué)像是。它是一套非常語(yǔ)義化的 troff 和 groff 宏。它具備標(biāo)記語(yǔ)言用戶所期望的大多數(shù)功能,如標(biāo)題、有序列表等等。ERf28資訊網(wǎng)——每日最新資訊28at.com

我的第一臺(tái) Unix 機(jī)器上也安裝了 “Writers' Workbench”,這對(duì)我們組織中需要撰寫技術(shù)報(bào)告但沒(méi)有特別進(jìn)行“引人入勝”寫作的許多人來(lái)說(shuō)是一個(gè)福音。它的一些工具已經(jīng)進(jìn)入了 BSD 或 Linux 環(huán)境,比如樣式(style)、用詞檢查(diction)和外觀(look)。ERf28資訊網(wǎng)——每日最新資訊28at.com

我還記得早在上世紀(jì) 90 年代初期,Solaris 附帶了一個(gè)標(biāo)準(zhǔn)通用標(biāo)記語(yǔ)言(SGML)工具,也可能是我們購(gòu)買了這個(gè)工具。我曾經(jīng)使用它一段時(shí)間,這可能解釋了為什么我不介意手動(dòng)輸入 HTML。ERf28資訊網(wǎng)——每日最新資訊28at.com

我使用過(guò)很多 Markdown,我應(yīng)該說(shuō)是“哪種 Markdown”,因?yàn)樗袩o(wú)數(shù)種風(fēng)格和功能級(jí)別。正因?yàn)槿绱耍也⒉皇?Markdown 的鐵桿粉絲。我想,如果我有很多 Markdown 要處理,我可能會(huì)嘗試使用一些 CommonMark 的實(shí)現(xiàn),因?yàn)樗鼘?shí)際上有一個(gè)正式的定義。例如,Pandoc 支持 CommonMark(以及其他幾種)。ERf28資訊網(wǎng)——每日最新資訊28at.com

我開(kāi)始使用 AsciiDoc,相比于 Markdown,我更喜歡 AsciiDoc,因?yàn)樗苊饬恕澳闶褂玫氖悄膫€(gè)版本”的討論,并提供了許多有用的功能。過(guò)去,讓我對(duì) AsciiDoc 感到困擾的是,有一段時(shí)間似乎需要安裝 Asciidoctor,這是一個(gè)我不太想安裝的 Ruby 工具鏈。但是現(xiàn)在,在我所用的 Linux 發(fā)行版中,有了更多的實(shí)現(xiàn)方式。奇怪的是,Pandoc 可以輸出 AsciiDoc,但不支持讀取 AsciiDoc。ERf28資訊網(wǎng)——每日最新資訊28at.com

那些嘲笑我不愿意為 AsciiDoc 安裝 Ruby 工具鏈,卻樂(lè)意安裝 Pandoc 的 Haskell 工具鏈的人……我聽(tīng)到你們的笑聲了。ERf28資訊網(wǎng)——每日最新資訊28at.com

我羞愧地承認(rèn),我現(xiàn)在主要使用 LibreOffice。ERf28資訊網(wǎng)——每日最新資訊28at.com

——Chris HermansenERf28資訊網(wǎng)——每日最新資訊28at.com

現(xiàn)在就編寫文檔吧!

文檔編寫可以通過(guò)多種不同的途徑來(lái)完成,正如這里的作者們展示的那樣。對(duì)于代碼的使用方法,特別是在開(kāi)源領(lǐng)域,進(jìn)行文檔編寫非常重要。這確保其他人能夠正確地使用和貢獻(xiàn)你的代碼。同時(shí),告訴未來(lái)的用戶你的代碼提供了什么也是明智之舉。ERf28資訊網(wǎng)——每日最新資訊28at.com

本文鏈接:http://m.rrqrq.com/showinfo-26-5150-0.html你喜歡哪種文檔標(biāo)記語(yǔ)言?

聲明:本網(wǎng)頁(yè)內(nèi)容旨在傳播知識(shí),若有侵權(quán)等問(wèn)題請(qǐng)及時(shí)與本網(wǎng)聯(lián)系,我們將在第一時(shí)間刪除處理。郵件:2376512515@qq.com

上一篇: 實(shí)現(xiàn)分布式事務(wù):Java與MySQL的XA事務(wù)協(xié)調(diào)

下一篇: 用這五個(gè)技巧將你的Vue技能提升到新的高度

標(biāo)簽:
  • 熱門焦點(diǎn)
Top 国产精品嫩草99av在线_一区在线视频观看_欧美高清一区_欧美 日韩 国产 一区_99精品欧美一区二区三区_久久大香伊蕉在人线观看热2_一色屋精品视频在线观看网站_在线亚洲国产精品网站_亚洲区一区二区三区_你懂的视频一区二区
欧美日韩成人在线一区| 91小宝寻花一区二区三区| 成人精品免费视频| 91久久精品国产91久久性色tv | 亚洲一区在线视频| 久草热8精品视频在线观看| 欧美日韩精品免费观看视频完整| 麻豆91精品| 国产区在线观看成人精品| 青草国产精品久久久久久| 欧美激情 亚洲a∨综合| 精品视频在线免费| 亚洲欧美日韩在线播放| 成人性生交大片免费看中文| 麻豆精品网站| 国产精品另类一区| 国产美女视频一区| 国产一区二区三区久久| 亚洲精品在线三区| 精品一区二区免费看| 一本一本久久| 久久免费电影网| 国内偷窥港台综合视频在线播放| 99国内精品| 久久精品日产第一区二区三区高清版| 另类小说色综合网站| 国产精品日本一区二区| 国产精品卡一卡二卡三| 成人av免费在线播放| 欧美色窝79yyyycom| 一区二区在线观看不卡| 国产综合亚洲精品一区二| 8x福利精品第一导航| 日韩av电影天堂| 国产精品有限公司| 亚洲国产精品国自产拍av| 国产成人免费视| 在线精品视频免费观看| 亚洲一区自拍偷拍| 亚洲狠狠婷婷| 亚洲人成网站色在线观看| 色综合天天综合给合国产| 精品国产a毛片| 成人午夜电影网站| 欧美一区二区在线免费播放| 久久99久久99| 欧美日韩黄色影视| 久久69国产一区二区蜜臀| 色欧美日韩亚洲| 亚洲1区2区3区4区| 免费日韩av| 午夜电影一区二区| 色婷婷狠狠综合| 日韩激情一二三区| 色哟哟精品一区| 欧美aaaaa成人免费观看视频| 久久资源av| 日本欧美一区二区在线观看| 色欧美日韩亚洲| 精品写真视频在线观看| 7777精品伊人久久久大香线蕉完整版| 精品国产乱码久久久久久浪潮| 欧美国产日产图区| 丁香网亚洲国际| 日韩美一区二区三区| 波多野结衣中文一区| 久久色中文字幕| 欧美日韩网址| 一区二区久久久久久| 美女精品在线| 精品无码三级在线观看视频| 欧美一级爆毛片| 91首页免费视频| |精品福利一区二区三区| 亚洲尤物精选| 久久99精品久久久久久动态图| 91精品国产综合久久小美女| 成人黄色免费短视频| 日本一区二区综合亚洲| 99国产精品久久久久久久| 日韩高清不卡在线| 5566中文字幕一区二区电影| 91香蕉视频污在线| 亚洲人成人一区二区在线观看 | 国产麻豆成人传媒免费观看| 日韩欧美一区二区免费| 国产精品v欧美精品∨日韩| 亚洲国产精品欧美一二99| 欧美伊人久久大香线蕉综合69| 国产资源在线一区| 国产欧美日韩视频一区二区 | 国产大陆精品国产| 国产区在线观看成人精品| 国产麻豆日韩| 精品一区二区三区日韩| 国产欧美日韩一区二区三区在线观看| 一区二区三区精品国产| 精品在线一区二区| 久久精品水蜜桃av综合天堂| 国产精品久久亚洲7777| 国产麻豆一精品一av一免费| 国产精品视频第一区| 91福利在线导航| 97久久精品人人做人人爽50路| 成人永久看片免费视频天堂| 中文字幕视频一区二区三区久| 色噜噜狠狠色综合欧洲selulu| 成人不卡免费av| 亚洲综合色网站| 精品少妇一区二区三区在线播放| 亚洲毛片视频| 成人国产在线观看| 亚洲国产精品影院| 久久夜色精品一区| 久久久久一区| 欧美日韩亚洲一区在线观看| 蜜臀av一级做a爰片久久| 日本一区二区免费在线| 精品污污网站免费看| 亚洲私人影院| 国产电影一区二区三区| 亚洲成av人片在线| 日本一区二区三区国色天香| 欧美美女网站色| 99av国产精品欲麻豆| 岛国精品在线观看| 日韩国产欧美在线观看| 亚洲欧美在线视频| 日韩欧美aaaaaa| 欧美三级视频在线播放| 99精品欧美一区二区三区| 99精品一区二区| 久久成人免费网站| 亚洲一区二区视频在线| 国产精品久久三区| 欧美第一区第二区| 欧美影院精品一区| 国产精品一区视频网站| 国产综合视频| 91视频在线看| 成人综合婷婷国产精品久久| 九九国产精品视频| 日韩电影免费在线观看网站| 一区二区在线免费| 中文字幕五月欧美| 日本一区二区视频在线| 欧美精品一区二区三区高清aⅴ | 久久精品国产清高在天天线 | 国产99久久久久久免费看农村| 日本亚洲三级在线| 一区二区三区在线视频观看 | 欧美在线观看视频一区二区 | 欧美成人嫩草网站| 成人禁用看黄a在线| 国产乱子轮精品视频| 理论片日本一区| 日本在线不卡视频| 性感美女久久精品| 亚洲国产欧美在线人成| 一区二区欧美精品| 亚洲另类在线一区| 亚洲欧洲性图库| 亚洲天堂2014| 亚洲精品免费在线| 一区二区在线免费观看| 亚洲综合免费观看高清完整版 | 自拍视频在线观看一区二区| 国产精品的网站| 国产精品女主播av| 1024国产精品| 亚洲免费观看高清在线观看| 亚洲精品网站在线观看| 一区二区不卡在线视频 午夜欧美不卡在 | aa级大片欧美| 欧美在线影院| 在线观看不卡| 国产精品日韩高清| 久久久久久9| 欧美伊人久久大香线蕉综合69| 欧美日韩一区久久| 欧美一区二区精品久久911| 欧美成人a∨高清免费观看| 久久久99精品免费观看不卡| 久久精品视频一区二区| 亚洲视频一二区| 午夜在线电影亚洲一区| 九色porny丨国产精品| 成人妖精视频yjsp地址| 欧美一区激情| 夜夜爽av福利精品导航 | www.在线欧美| 亚洲视频精品| 久久婷婷丁香| 日韩视频中午一区| 国产欧美一区二区三区在线老狼| 日韩一区欧美一区| 视频一区二区国产| 成人在线综合网| 亚洲日韩视频| 欧美视频你懂的|