Quantcast
Channel: swift – AppCoda
Viewing all articles
Browse latest Browse all 172

如何使用 Markdown 為 Swift 程式碼加入註解

$
0
0
swift-code-doc

Markdown 語法用一些特殊的關鍵字來描述文檔中的不同部分,比如參數、函數返回值等,從而使這些結構顯示出不同的樣式。新的 Markdown 文檔風格,最大的優點之一,是它允許對文本樣式進行更加靈活、徹底和豐富的定制。當然,如果你仍然想使用舊式的文檔風格,請參考先前的這篇教程。 對於每一個開發者而言,為程式碼加入註解是一種極好的習慣。雖然它表面上看起來會對開發進度有一定的影響,但這本身亦應當屬於開發過程的一部分。這並不意味著我們要對項目中存在的屬性、函数、類、結構或其它每一樣東西事無巨細地編到文檔中去,這根本是不可能的事情。而是應該「合理」說明解釋,也就是: 描述類、方法和屬性的用途,粗略程 […]

你可以到 如何使用 Markdown 為 Swift 程式碼加入註解 閱讀完整文章。如果你對其他iOS教程有興趣,歡迎到 AppCoda 繼續瀏覽。


Viewing all articles
Browse latest Browse all 172

Trending Articles