使用Appledocs生成文檔

Question

我對我的問題的簡單道歉，但我嘗試使用Appledocs（https://github.com/tomaz/appledoc#quick-install）

生成文檔我不知道究竟是如何得到它的設置。我這樣做的方式是：

• 我克隆GitHub庫，然後使用在終端安裝腳本（我確認這使用appledocs --help）安裝appledocs。
  • 我怎麼產生
  • 是它產生在文檔文件：

  不過，現在我怎麼居然在我有我的項目在Xcode感覺用這個？

Answer 1

我總是做的是添加一個新的目標到我的項目，可以生成文檔。您可以進入項目構建階段並點擊「添加目標」。選擇「其他」下的Aggregate並給它一些名稱（例如ProjectDocumentation）。

仍然在構建階段標籤上，點擊'添加構建階段'，然後點擊'添加運行腳本'。現在，您可以粘貼以下並調整到你自己的設置：

/usr/local/bin/appledoc \ 
--project-name HereProjectName \ 
--project-company "HereProjectCompany" \ 
--company-id com.companyName \ 
--keep-undocumented-objects \ 
--keep-undocumented-members \ 
--search-undocumented-doc \ 
--exit-threshold 2 \ 
--ignore .m \ 
--output "AppleDoc" . 

我用的是忽略* .M因爲我只只在我的頭文件寫文檔。我的* .m文件中的文檔僅適用於我自己（因此是私人的）。 當您構建此目標時，文檔將生成爲XCode文檔集。這可以通過點擊類名來訪問。查看AppleDoc website的評論語法。

有關命令行選項的說明，請查看appledoc --help命令。

Answer 2

推薦的方法是clone GitHub project and compile the tool from Xcod e。由於克隆GitHub項目將創建與主存儲庫的鏈接，它也極大地簡化了未來的升級。要安裝，請在終端中鍵入以下內容：

git clone git://github.com/tomaz/appledoc.git 

這將創建appledoc目錄。在你可以找到appledoc.xcodeproj Xcode項目;打開它並編譯appledoc目標 - 這應該是開箱即用的，但是你的系統必須滿足最低系統要求，見下文。我建議您將生成的appledoc可執行文件從build目錄複製到路徑中的某個目錄（echo $ PATH），以使其可以輕鬆訪問。

可選：Appledoc是selfcontained幷包含必要的模板文件。如果你想修改從模板子目錄這些默認的預期位置之一：

~/Library/Application Support/appledoc 
~/.appledoc 

瞭解更多信息visit

Answer 3

例如，像這樣的，它是對latests源代碼文檔一個有效的頭Appledoc。

// 
// GSUserDefaults.h 
// 
// Created by Gabor Szabo on 30/01/2013. 
// 
// 

#import <Foundation/Foundation.h> 


/*! 
@discussion This class manages the user defaults on the device with some extra convenient methods. 

## Version information 

__Version__: 1.0 

__Found__: 2013-01-30 

__Last update__: 2013-01-30 

__Developer__: Gabor Szabo, TMTI Ltd. 

*/ 

#pragma mark - Interface 

@interface GSUserDefaults : NSObject { 

} 

#pragma mark - Class Methods 

#pragma mark - Getters 

/// @name Getter methods 

/*! 
@abstract Returns the value for the key. 
@discussion It reads the values from the `NSUserDefaults`. 
@param key The key, it must be not `nil`. 
@return The value object for the key. 
@exception NSException Thrown when the key is `nil`. 
@since 1.0+ 
*/ 
+ (id)valueForKey:(NSString *)key; 

/*! 
@abstract Returns a value collection for the keys. 
@discussion It reads the values from the `NSUserDefaults`. 
@param keys The set of keys, which are affected. 
@return The value collection for the desired keys. 
@exception NSException Thrown when the key is `nil`. 
@since 1.0+ 
*/ 
+ (NSDictionary *)valuesForKeys:(NSSet *)keys; 

#pragma mark - Setters 

/// @name Setter methods 

/*! 
@abstract Sets a value for the selected key. 
@discussion The value always will be overridden. It sets the value to the `NSUserDefaults`. 
@param value The value object, it can be `nil`, in case of `nil` the key will be removed from the `NSUserDefaults`. 
@param key The key for the value, it cannot be `nil`. 
@exception NSException Thrown when the key is `nil`. 
@since 1.0+ 
*/ 
+ (void)setValue:(id)value forKey:(NSString *)key; 

/*! 
@abstract Sets `nil` values for the selected keys. 
@discussion The value always will be overridden. It removs the from the `NSUserDefaults`. 
@param keys The set of keys, which are affected. 
@since 1.0+ 
*/ 
+ (void)setNilValueForKeys:(NSSet *)keys; 

/*! 
@abstract Sets a default value for the selected keys. 
@discussion It the key already exists, it won't be overridden, if the value was `nil` for the key, the key gets the value. It sets the values to the `NSUserDefaults`. 
@param defaultValue The value object, it could be `nil`, in case of the `nil` just nothing will happen, the keys won't be removed. 
@param keys The set of keys, which are affected. 
@since 1.0+ 
*/ 
+ (void)setDefaultValue:(id)defaultValue forKeys:(NSSet *)keys; 

/*! 
@abstract Sets the value for the selected keys. 
@discussion The values always will be overridden, if the value was `nil` for the key, the key gets the value. It sets the values to the `NSUserDefaults`. 
@param value The value object, it can be `nil`, in case of `nil` the key will be removed from the `NSUserDefaults`. 
@param keys The set of keys, which are affected. 
@since 1.0+ 
*/ 
+ (void)setValue:(id)value forKeys:(NSSet *)keys; 

@end