寫作格式

寫作格式

在上面說的兩本電子書中,都有提及寫作風格的說明,鐵人賽的一系列文章也會遵照這個格式來寫作。主要的重點有幾個:

  • 專有名詞: 對於專有名詞不進行中文翻譯,而是使用括號(())加註其後作為補充翻譯。例如state(狀態)

  • 符號: 對於符號儘可能在其後使用括號(())加註其後。例如加號(+)

  • 不使用分號作為每行程式碼的結尾: 在使用JavaScript程式碼作為範例解說時,不使用分號(;)作為每行程式碼的結尾。

  • 英文字詞解說: 針對重要的專業字詞,提供英文解說,並加入相關的字詞說明。

至於以下的部份由於時間的關係,無法一一作註解:

  • 風格指引: 參考目前網路上知名的數個Javascript程式碼撰寫風格指引,提供在每個段落相關的建議。

  • 讀音(用中文拼音): 使用"以中文讀音拼出英文字詞"的作法。

註: "不使用分號作為每行程式碼的結尾"是一種JavaScript程式撰寫的格式風格,詳細的內容可以參考這篇文章JavaScript裡的語句用分號結尾是個選項嗎

其他的呈現方式

以下是為本書的其他的幾個輔助的教學呈現方式:

圖片

圖片會使用於幾個地方:

重點標註出每段文章

主要解說程式碼或文章內容的重點。下面是個展示:

展示簡單實作成果

這會使用gif圖片,展示實作成果的樣子。下面是個展示:

影片

為方便解說操作的步驟,文章與圖片的敘述可能沒辦法很容易的解說步驟的進行,所以有些文章會特別錄製影片。所有的影片都會集中在這個Youtube頻道:

錄製的影片會以10分鐘以內為限,搭配解說的聲音,字幕如果有時間會加上。

Github庫

本書的Github庫,內容包含所有的文章文字內容、圖片與程式碼範例,如果你看不到圖或文字、程式碼等等,可以到這裡去看。網址如下:

其他參考

Last updated