程式環境 Xcode 13.2.1
“寫代碼要經常寫注釋，”雖然很多人不以為然，但是在使用Xcode的時候，我們在寫注釋的時候稍微注意一下格式的話，Xcode會給我們帶來額外的正反饋，而所謂“正反饋”就是我們的注釋會自動轉換成幫助檔案，顯示在quick help上，
簡單的注釋
///注釋A
///
///hello world
- (void)functionA {
}
這里做注釋要用三個斜杠/，而且每個部分之間要用空行間隔開來，
在這里看quick help，就會發現除了Declaration、Declared In之外，還出現Summary、discussion（不顯示的同學記得cmd+s保存一下）
對引數的注釋
我們定義的方法有很多時候是會帶引數，如果我們要在注釋里面對引數添加注釋的話，只要新起一行將param + 引數名即可，
///注釋A
///
///@param param1 引數1
///@param param2 引數2
///
/// hello world
這里有同學會好奇如果把中間的空行去掉會怎樣，這就牽扯到一個問題：注釋可能會出現長到不能完全在一行內顯示，這個時候的做法是直接換到新的一行接著寫
///注釋A
///wewe
///
///@param param1 引數1
///@param param2 引數2Mr
///Yu4
///
///hello worldMM:
///SS
注釋的引數
上一節我們用了@param這個引數來做注釋，其實我們還可以還有許多引數來放進注釋,而且我們將引數名寫進去了之后，各個引數之間不需要空行隔開了
///@brief 注釋A
///
///hello world
///@param param1 引數1
///@param param2 引數2
///@author MrYu4
///@warning 警告警告
///@version 1.0.0
另一種注釋法
之前介紹的是三個/做的注釋，其實還可以用另一種注釋方法，
/**
* @brief 注釋A
*
* hello world
* @param param1 引數1
* @param param2 引數2
* @author MrYu4
* @warning 警告警告
* @version 1.0.0
*/
轉載請註明出處，本文鏈接：https://www.uj5u.com/yidong/433369.html
標籤：iOS