程式設計師必知必會之blog篇

2021-07-10 07:46:11 字數 3787 閱讀 4560

程式設計師必知必會之blog篇

網易廣州       賴勇浩(

本文最初發表於戀花蝶的部落格(

緣起

雖然我寫部落格到現在只有兩年多時間,但因為文章多是原創,還經常被推薦到csdn首頁,又在幾個雜誌上灌過水,所以也有不少朋友問過我相同的話題:我在學習/工作中有很多感悟,但我寫不出來啊,有什麼好方法嗎?問這個問題的有師弟師妹,也有朋友同事,甚至有一些是有近十年經驗的資深技術人員。

後來看到csdn blog開通了近20萬個專欄,卻只有不到55萬篇原創文章,平均乙個專欄還不到三篇文章。這說明有很多程式設計師,想寫卻寫不出來,寫了卻沒能堅持下來。這終究是乙個方法問題。

向我諮詢的一位有十年經驗的資深技術人員,他給我看了一些他的作品。我驚嘆於其中的技術,極力鼓吹他把其中的技術體會寫出來,但他的回答是:我也想寫出來給大家參考,但我下筆寫不了三句話啊!

看圖作文

無論現在你的成就多大,你也不得不承認在小學(甚至是幼兒園)學到的東西讓你終生受用無窮。看圖作文就是這樣一門有用的學問。

看著上面搞笑的漫畫,無論是誰都能寫上一兩百字吧?

其實,看圖作文法是寫部落格的好幫手哦!君不見多少**編輯就靠這招就能混得人模狗樣有房有車麼?千萬不要小看啊!我們寫技術文章的時候,可以套用這樣乙個套路來寫文章:

1、 先畫幾幅圖,如軟體需求圖、架構圖、介面圖、細節圖等若干;

2、 針對每一幅圖寫一段話,三五句,講清這幅圖的功用即可;

3、 去掉,通讀全文,做好各段的銜接;

4、 修改文章,直到滿意為止。

一開始我們就多弄點圖,像太平洋電腦網的評測文章一樣。慢慢地,圖的數量降下去,文字的數量公升上來。最終,您終於修練成word無圖而心中有圖的不二法門,就神功已成了!

回眸說明文

咳,大家都還記得說明文是我們學習過的眾多文體之一。但作為乙個技術部落格的作者,寫的文章大多應該是說明某一種技術(或演算法或架構)實現。因此掌握說明文的寫作有著舉足重輕的意義,在繼續下一步之前,我們有必要再複習一下說明文的一些要素。

說明文是解說事物、闡明事理的文章體裁,最重的是要把特徵、本質和規律講清楚明白。說明文通常都具有知識性,這種知識可能來自於文獻資料、研究資料或者自己的實踐和調查所得。說明的時候要有一定的條理性,也就是順序,必須搞事物特徵或者人的認識規律來安排。知識性和條理性方面最好的范文就是各種藥物的說明書了。在這裡有乙份「小兒甘草鋅片」的說明書

如果大家對照葫蘆畫瓢,把自己要分享的技術(或演算法或架構)以這種填表式表達出來,未嘗不能達到清晰明了的效果。您可能會笑話我竟然把技術跟藥品混為一談,並認為他們風牛馬不相及,但我給你舉個例子,你看看有著最完善的技術文件之稱的msdn,是不是像極了藥品說明書?下面看個.net類庫里的keyboard類的文件:

語法、備註、示例、層次、安全、版本和參考資訊,一類一類列下來,簡明清晰,我等學習的典範。

說明文主要是說明事物給人知識,所以既可以寫得平實(如msdn),也可以寫文藝化一些(如我的部落格上的《mixn掃盲班》

說明的方法有下定義、作詮釋、作比較、打比方和分類別等等,具體的可以再參考當年的教科書。

十句作文法

上面廢話了這麼多,難得您還能忍著嘔吐感看到這裡。為了報答您對我的賞識,我決定在這一節開始白話一下我的兩個獨門密招:十句作文法和測試驅動寫作。咳,雖然我號稱獨門,不過據我所知,用這兩招的人非常多,相當多;特別是苦難的高考期間緊張在黑色六月的祖國的花朵們,經常用這兩招。

十句作文法不是我原創,是中學的時候,我的英語老師教我的。那時我數學經常考一百分,語文就差了點。我的老師看在眼裡急在心裡,為了培養乙個能文能武的學生,他在某個冬日的午後,在痛批恨鐵不成鋼之後把這個獨門秘方傳授於我,從此我就走上了作文高分之路。

首先要指出的是十句作文法並不是一定要寫十句,通常是8-12句。這種方法對付考試是最有效的,但也可以應用在我們的技術文章寫作當中。十句作文法其實是最低階的寫作方法,汗,我在前面似乎把它吹得太神乎了?因為十句話往往只有200個字左右。200個字能說清楚些啥啊?沒關係,只要我們不停地迭代(不知道

什麼叫迭代?)和遞迴(不知道

什麼叫遞迴?)應用這個方法,200個字也能清易擴充套件到2000個字。古龍曰過了,最簡單的,就是最有效的。

文章就像水,沒有固定的形狀。不過,文章也像水,有源頭、有主體和終端;就像再長的河流也最終也要流入大海,再長的文章,也逃不過「始、中、終」三個字。只要我們掌握了這一點,自然就能一切通殺了。

有了上述理論(氣宗)指導,下面十句作文法(劍宗)就顯得相當簡單了:

始(第一段):

主題句一句,通常應用開門見山法。

擴充套件句一句,用以深化主題,通常應用烘雲託月法。

中(第二段):

簡介一句,通常應用承前啟後法。

下面用時間、空間、邏輯、總分、並列或者因果等法講述事物

/事理,共六句。要用的方法有彩線穿珠、小中見大、順應時空、尺水興波和聯想對照等。

終(第三段):

結束句一句,用以總結全文、昇華主體思想,最典型的做法是:啊,多麼偉大的中國人民啊,他們創造了與世無匹的世界奇蹟!

有了這十句之後,我們就可以以小段為大段,以句為小段,對每一句再應用一次十句作文法,文章自然就體積脹大,而且結構分明,看起來蠻像一回事了。(附註:如果有讀者正在考英語四六級之類的考試,十句作文法絕對可以幫到你!)

本文最初發表於戀花蝶的部落格(

測試驅動寫作

測試驅動寫作的靈感來自於程式設計界流行的測試驅動開發(test driven development,簡稱tdd),簡稱tdw。因為tdw和著與tdd相同的血統,所以tdw也有著tdd的優勢。文章簡潔可用是tdw的目標,它通過先思考如何撰寫文章,並羅列相關的問題要點,然後再寫出文字;通過比對問題要點,迴圈修改新增其它觀點,直到文章完成。大家都是程式設計師同行,tdw的優點我就不說了,請參考大家耳熟能詳的tdd優點;下面我只是談談tdw的過程:

1) 明確要寫的主旨和內容,最好是列乙個提綱。

2) 在**上寫明這篇文章要達到的目標、效果、字數甚至體裁和段落,作為測試用例。

3) 利用十句作文法(或者其它方法)快速完成乙個文章原型。

4) 針對測試用例比對,記錄下未完成和完成得不好的地方(bugs)。

5) 修正bugs,然後再回到第4步

6) 對文章進行重構,潤色。(放到blog上的話,這一步可以不做)

7) 文章完成。

由tdw的過程可見,十句作文法是tdw的基礎,要進行tdw,必須有一種快速的原型開發方法。tdw是對十句作文法的擴充套件和迭代,是彌補十句作文法寫的文章有骨無肉缺陷的有效手段。只要掌握了這兩種方法,肯定能寫出受人肯定的技術文章,為自己的部落格添光彩。

next works

詩人陸游《示兒》詩中說:「詩為六義一,豈用姿狡獪。汝果欲學詩?功夫在詩外!」

是啊!雲對雨,雪對風,晚照對晴空。要學會這些套路並不是難事。就像武學一樣,在學會長拳通臂之後,講究的是融匯貫通。無敵寂寞到左右手互博的周伯通也打不過楊過單手黯然消魂掌,是因為楊過已經把他對生活的感悟融進了功夫之中。李杜兩人領銜中國詩界一千餘年無人出其右,也正是因為他們的詩已經融入了他們對生活的感情!放翁一句「春如舊,人空瘦,淚痕紅浥鮫綃透」讓多少人為之淚流,也是因為《紅酥手》這首詞融入了他幾十年的情感!

相信通過我的文章,讀者能夠掌握一些寫作的方法和技巧。也許在一段時間之後,您也喜歡上了寫部落格,喜歡上了與大家分享自己的所得所思。這時您可能想把自己的文章寫得更有文采一些,也許您仍然會回來問我,希望我再跟您交流經驗。我在這裡先說一句吧,我不是大文豪,如何把文章寫更富有文采和風格,那不是我能回答的問題。我只有一句話也大家共勉:

功夫在文外,文章不夠好,歸根結底是因為對生活的積累太少。

程式設計師必知必會之maillist篇

程式設計師必知必會之email篇

程式設計師必知必會之blog篇

程式設計師必知必會之blog篇 網易廣州 賴勇浩 本文最初發表於戀花蝶的部落格 緣起 雖然我寫部落格到現在只有兩年多時間,但因為文章多是原創,還經常被推薦到csdn首頁,又在幾個雜誌上灌過水,所以也有不少朋友問過我相同的話題 我在學習 工作中有很多感悟,但我寫不出來啊,有什麼好方法嗎?問這個問題的有...

程式設計師必知必會之blog篇

程式設計師必知必會之blog篇 網易廣州 賴勇浩 本文最初發表於戀花蝶的部落格 緣起 雖然我寫部落格到現在只有兩年多時間,但因為文章多是原創,還經常被推薦到csdn首頁,又在幾個雜誌上灌過水,所以也有不少朋友問過我相同的話題 我在學習 工作中有很多感悟,但我寫不出來啊,有什麼好方法嗎?問這個問題的有...

程式設計師必知

1.乙個程式設計師用在寫程式上的時間大概佔他的工作時間的10 20 大部分的程式設計師每天大約能寫出10 12行的能進入最終的產品的 不管他的技術水平有多高。好的程式設計師花去90 的時間在思考 研究和實驗,來找出最優方案。差的程式設計師花去90 的時間在除錯問題程式 盲目的修改程式,期望某種寫法能...