寫作目的和內容決定技術文章貼代碼的方式

早上看了一位朋友的文章,這位朋友在文章中犯了愁,他說:"我之前寫過一些文章,因爲沒有貼代碼,----準確的說,是沒有貼全代碼而遭人罵。",一些人直接給文章回復"說那麼多廢話幹什麼,快貼代碼","把代碼發至某某信箱"之類的.面對這樣的留言,作者無語了,他們"是來這裏找技術?還是找代碼?",文章最後問道:"一篇真正的技術文章,應該怎麼寫?"

其實,經常在一些技術網站上泡的人,時常會看到這樣的留言,我們大可不必爲這些爲煩惱.寫我們的技術文章,讓這類人叫去吧.讓真正關心技術的人分享到我們的技術纔是寫作的目的和初衷.

我覺得貼不貼代碼,貼什麼樣的代碼,貼多少,這些問題應該由文章的寫作目的,主題及內容需要來定.

因爲,代碼只是爲了更加清晰明瞭的闡述我們要說明的內容,幫助讀者理解作者的思想.對於那些與主題無關的,或對闡述主題可有可無的代碼只會使文章更加難以讓人明白,干擾正常理解與閱讀.

那些只知道要代碼的人,他們閱讀的目的根本就不是想要了解你文章所闡述的技術,而僅僅是想得到你的代碼.這樣的人基本上可以看成是"IT乞丐",網絡上的"IT乞丐"確實不少,但他們是永遠也理解不了技術的真諦的.

我們寫技術文章也不絕是爲了得到這類"IT乞丐"的"讚賞",而是想和更多的人分享技術. 因此,對於那此只知道浮躁的叫嚷着要代碼,又不知道去理解技術,不尊重作者寫作成果的人,我們大可以不必理會,這類人不值得花時間和精力去滿足他們.

授人以魚,不授人以漁.技術比代碼更重要.所以,我覺得寫技術文章,應該着重闡述技術,這樣,用心的讀者能從中悟出許多,舉一反三,逐類旁通,理解技術的真諦.而純粹的代碼基本上只能讓人知其然,而不知其所以然.故只能把代碼當成是技術文章的一部分,用它來更好的爲闡述技術內含服務,爲理解技術服務.

當然,如果文章引用的代碼片段不足以說明技術,或代碼本身讓人迷惑,那將會使文章的功效大打折扣.因此,對於引用代碼的選擇是需要經過作者精心思考和設計選擇的.不能只簡單的COPY一段了事.選擇代碼例子時候應該考慮代碼的完整性,嚴謹性和針對性.一篇好的技術文章所引用的每一個代碼例子,都是經過作者精心設計的,精選的代碼反過來可以使技術闡述更加明瞭,更加讓人易於接受.

總之,作者根據文章需要來決定如何選用代碼,選用好的代碼可以使作者的文章生輝不少.

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章