如何讓Xcode在用戶定義的方法下顯示註釋？

Question

如果我們從Apple API鍵入方法，Xcode將在自動完成彈出列表下方顯示方法功能。但是輸入一個用戶定義的方法，它什麼也沒有顯示。

有沒有辦法告訴Xcode顯示我自己定義的一些描述，以顯示如何使用用戶定義的方法？

謝謝!!!

---

@HAS：

我按照你的指令，直到第12步，而在.h文件中創建一個簡單的測試類爲：

#import <Foundation/Foundation.h> 

@interface AMCAppleDocTest : NSObject 
@property (nonatomic, retain) NSString *version; 
+ (id) test; 
/** @name Section title */ 
/** Method description */ 
- (void)doSomething; 
@end 

然後到第13步，我運行腳本，但發生錯誤的圖片下面：

http://oi43.tinypic.com/686lqd.jpg

我.SH腳本：

#! /bin/sh 
docsURL="http://www.AMC.com"; 
projectsPath="$2/../"; 
docsPath="/Users/AMC/Library/Developer/Documentations/$1"; 

# create AppleDocOutput folder if not exists 
if [ ! -d $docsPath ]; 
then 
mkdir "${docsPath}"; 
fi 

/Users/AMC/Library/Developer/DocumentationStuff/appledoc \ 
--project-name "$1" \ 
--project-company "AMC" \ 
--company-id "com.AMC" \ 
--docset-atom-filename "$1.atom" \ 
--docset-feed-url "${docsURL}/%DOCSETATOMFILENAME" \ 
--output "/Users/AMC/Library/Developer/Documentations/$1" \ 
--docset-package-url "${docsURL}/%DOCSETPACKAGEFILENAME" \ 
--docset-fallback-url "${docsURL}/$1Doc/" \ 
--publish-docset \ 
--logformat xcode \ 
--keep-undocumented-objects \ 
--keep-undocumented-members \ 
--keep-intermediate-files \ 
--no-repeat-first-par \ 
--no-warn-invalid-crossref \ 
--ignore "*.m" \ 
--ignore "LoadableCategory.h" \ 
--index-desc "$2/readme.markdown" \ 
"$2" > "${docsPath}/AppleDoc.log" 

而且.command文件：

#!/usr/bin/osascript 

tell application "Xcode" 
    tell first project 
     -- variables to export 
     set projectName to (get name) 
     set projectDir to (get project directory) 
     set company to (get organization name) 
     -- invoke script passing extracted variables 
     do shell script ("sh /Users/AMC/Library/Developer/DocumentationStuff/appledoc.generate.sh " & projectName & " " & projectDir & " " & company) 
    end tell 
end tell 

再說，我的版本的Xcode 4.5.1是和OS X 10.8。

Xcode未安裝到/ Applications文件夾中，而是放在桌面上。有關係嗎？

---

@再次具有

我發現了什麼問題：劇本是在DOS格式。我在VI中使用解決了這個問題：set ff = unix。現在每天的事情去perfectlly：

http://oi43.tinypic.com/2uj58yb.jpg

Answer 1

在我以前的答案，我建議appledoc（這是夢幻般的BTW），但你想要的東西是在Xcode 5更容易使用其內置的文檔功能（用於舊的答案看看編輯歷史）。

比方說，你有一個方法，如：

- (NSString *)fooBar:(NSNumber *)foo bar:(NSArray *)bar { 
    return @"FooBar!"; 
} 

所有你必須補充的是

/** 
* This is a demo method 
* 
* @param foo An NSNumber. 
* @param bar An NSArray. 
* 
* @return Returns the NSString "FooBar!" 
*/ 
- (NSString *)fooBar:(NSNumber *)foo bar:(NSArray *)bar { 
    return @"FooBar!"; 
} 

當輸入的方法，你可以在酥料餅的底部看到信息

如果你al牛逼 -Click你得到所有的信息的方法：

如果你是懶惰（像我一樣）看看被叫VVDocumenter好的插件。您只需使用該插件就可以在方法上面輸入///，並自動爲您生成文檔結構。

只需下載，編譯，複製並啓動記錄！感謝onevcat提供這樣一個真棒工具！