a dome method
:param: input an int number
:returns: the string represents the input number
func method(input:int) - > string {
return string(input)
在文件注釋的塊中（在這裡是被/**...*/包圍的注釋），我們需要使用:param:緊接輸入引數名的形式來表達隊輸入引數的說明。如果有多個引數，我們會需要相應地多寫陣列:param:語句。如果返回值不是void的話，我們還需要寫:returns:來對返回進行說明。
對於像屬性這樣的簡單的宣告，我們直接使用///就可以了。
struct person {
///name of the person
var name:string
也可以使用一款叫作vvdocumenter的xcode外掛程式。
Swift 文件注釋規範
的結構和組織關乎了開發童鞋們的節操問題。明確和一致的 表示了明確和一貫的思想。編譯器並沒有乙個挑剔的口味，但當談到命名，空格或文件，人類的差異就體現出來了。nshipster 的讀者無疑會記得去年發表的關於文件的文章，但很多東西已經在 xcode 6 中發生了變化 幸運的是，基本上算是變得更好了 因...
技術總結 swift文件注釋總結
作為乙個有 潔癖的猿類，對整潔的注釋必須要強迫症，xcode為我們提供了十分豐富的文件提示功能，在開發過程中，我們可以十分方便的按下option鍵，選中乙個類或者方法檢視其文件說明。而實際開發過程中我們也可以使用規範的方法新增注釋，達到這樣的效果。本篇主要介紹幾種常用的文件注釋方法。多行注釋文件相比...
python注釋文件
python有一種獨一無二的的注釋方式 使用文件字串，文件字串是包 模組 類或函式裡的第乙個語句，這些字串可以通過物件的 doc 成員被自動提取，並且被pydoc所用。1 注釋文件 2 檢視python的模組和函式幫助文件方法 1 注釋文件 乙個文件字串應該這樣組織 首先是一行以句號，問號或驚嘆號結...