Markdown是否是一個程序員必會的文檔編輯技能?


本人10年開發培訓經驗,期間經歷了Java,Android,H5,大數據,PHP等多個不同的方向的開發,也做過軟件培訓公司的金牌講師,很有興趣回答你這個問題。

首先我覺得因為程序員也是分三六九等的,有的程序員天天就是寫點業務代碼,也涉及不到寫文檔,頂多就是看看別人寫好的文檔。在這種情況下,其實他不會Markdown文檔編輯,也並不是什麼丟人的事,畢竟編輯文檔並不是每個公司對程序員的必然要求。

另外Markdown就是一個文本編輯器而已,無非就是對文檔格式化做的比較好,既可以格式化文檔標題,也可以更高級點,可以對代碼塊,表格,圖片,超鏈接等進行編輯,最終寫出一個比較好看的文檔來。相對於普通的txt文檔,也就是高級了這些,僅此而已。這有什麼高級的呢?

如果要使用Markdown,我覺得只要是一個正常人,10分鐘足夠熟悉Markdown的使用了,沒那麼神奇也沒有那麼難。

還有就是即使我們不按照Markdown軟件,現在有道雲筆記,或者CSDN,知乎等網站,編寫博客都可以直接在線Markdown格式或者富文本編輯器格式,最終做出來的效果都是一樣的。

如圖所示:

所以呢,要想寫出一個格式良好的文檔,Markdown並不是必須的,實現方案有很多,每個人的使用習慣不一樣,只要最終的目標實現了,誰管你用哪個東西呢?


我從事開發培訓10年,擅長Java,Android,H5,大數據,PHP等多個不同的技術方向。後續我會寫一系列關於互聯網技術方面的文章,感興趣的朋友可以關注我。另外如果你有Java,Android,H5等開發方面,或者是求職方面的問題,也可以在評論區留言,或者私信我,相信一定會讓你有所收穫!


一一哥Sun


我覺得是的。

平時寫技術文檔時,基本都是用的markdown,代碼塊、流程圖、序列圖、甘特圖、列表等應有盡有。非常方便程序員書寫。

建議答主學會這個程序員必備的文檔編輯技能,便於在日常的工作中提高溝通的效率,平時也可以用markdown,在github上提交自己的項目描述readme和搭建自己的博客。

1. 斜體和粗體
使用 * 和 ** 表示斜體和粗體。
示例:
這是 *斜體*,這是 **粗體**。


2. 標題
使用 #加空格表示一級標題,同理,##加空格表示二級標題
# 一級標題
## 二級標題
### 三級標題
#### 四級標題
##### 五級標題
###### 六級標題

3. 外鏈接
使用 [描述](鏈接地址) 為文字增加外鏈接。
示例:
這是去往 [我的博客](https://plutoyer.github.io/) 的鏈接。

4. 無序列表
使用 - 表示無序列表。
示例:
- 無序列表項 一- 無序列表項 二- 無序列表項 三


5. 有序列表
使用數字和點表示有序列表。
示例:
1. 有序列表項 一2. 有序列表項 二3. 有序列表項 三


6. 文字引用
使用 表示文字引用。
示例:
野火燒不盡,春風吹又生。

7. 行內代碼塊
使用 `代碼` 表示行內代碼塊。
示例:
讓我們聊聊 `html`。


8. 代碼塊
使用 四個縮進空格 或 ``` 表示代碼塊。
示例:
```這是一個代碼塊,此行左側有四個不可見的空格。```


9. 插入圖像

![image](圖片鏈接)


10. 插入音樂
**插入單曲**在網易雲音樂裡找生成外連接,複製過來就OK了,可惜的是很多都不能生成外聯連接。如果不想自動播放,可以把auto改成1[這一生關於你的風景](https://music.163.com/song/media/outer/url?id=1356350562.mp3)


匹諾曹的烏托邦


我是【會點代碼的大叔】,每天為你分享程序員乾貨,關注並私信我數字“1”,送你一份程序員大禮包。


在我看來,一名程序員可以學習一下 Markdown ,但是並沒有到非學不可的地步。


Markdown 是一種輕量級的【標記語言】,它讓我們使用純文本格式編寫文檔;這裡提到的語言,並不是某種編程語言,也並不是只有程序員可以使用的。

通俗地說,Markdown 其實就是一套語法、一套規定,我們在編寫文檔的時候,增加一些符號,就可以達到某些效果,比如加粗、多級標題、列表等等;如圖:


圖 - 1,我們編輯的內容,可以看到我們使用了 #、##、``` 這些標記符號。


圖 - 2,最後的效果



Markdown 的優點

  • Markdown 常用的標記符號也就十來個,就算是一個非程序員,學習這些標記符號也只需要幾分鐘的時間,而一旦熟悉了這種語法規則,會讓我們文檔編寫的速度變得非常的快。
  • 讓作者可以專注文字內容,而需要關心排版樣式,可以更安心地寫作;
  • 純文本,你可以使用任何文本編輯器;
  • Markdown 默認的文件格式是 .md,不過也可以輕鬆地導出 HTML、PDF、Word 等等;

Markdown 的語法

  • 標題:在本段文字之前加 # 號,就表示一級標題,## 就是二級標題,最多可以到六級;
  • 列表:無序列表使用 - 或 * ;有序列表使用數字 1. 2. 3. ,符號或數字與文字之間有一個空格;
  • 引用:使用大於號 >;
  • 粗體:兩個 ** 中間的文字,會被加粗;
  • 斜體:兩個 * 中間的文字,會變成斜體;
  • 圖片:![圖片的備註](圖片的地址);
  • 鏈接:[鏈接的文字](鏈接的地址);
  • 代碼框:被兩個 ``` 包裹起來;
  • 分割線:三個 * ;



我現在使用的 Typora 這個軟件,現在很多網站也都支持 Markdown 語法,我們可以在本地編輯好,然後直接發佈到這些網站上;這樣可以讓我專注寫作內容,不需要花精力在格式上。


作者:會點代碼的大叔 ,一個寫代碼的架構師,專注程序員的學習和成長,關注並私信我數字“1”,送你一份程序員大禮包。


分享到:


相關文章: