Q

Objective-C：製作文檔

2010-05-12 63 views 2 likes

2

我一直在爲Visual Studio和C＃開發很長一段時間。現在，我正在使用XCode和Objective-C進行開發。Objective-C：製作文檔

在C＃上，我可以使用/// <summary>生成文檔。 有沒有像XCode那樣的機制來生成文檔？和應該使用什麼樣的評論？

謝謝。

2010-05-12 VansFannel

A

回答

4

您是否試過使用Doxygen？這聲稱支持Objective-C。 ADC上甚至有walkthrough。

2010-05-12 13:35:48

+0

我應該使用什麼樣的評論？ – VansFannel 2010-05-12 13:40:37

+0

@ VansFannel：Doxygen評論。閱讀Doxygen文檔：http：//www.stack.nl/~dimitri/doxygen/docblocks.html – 2010-05-12 13:59:44

+1

Doxygen的+1 - 它不完美，但它是相當可敬的。由於Apple使用HeaderDoc生成大部分文檔，因此使用兼容的評論樣式最爲一致。我傾向於使用'/ *！ ... * /'我自己。 – 2010-05-13 04:51:52

1

還有AppleDoc渲染你的Doxygen註釋到這是由蘋果公司推薦的代碼文檔通過Xcode的

2010-05-12 20:14:22 RyanWilcox

+0

我一直在使用appledoc和doxygen的組合。適合我。 – drekka 2010-10-04 05:28:32

0

這樣說，我最喜歡的圖案:)

/////////////////////////////////////////////////////////////////////// 
    /// \brief setX 
    /// \param x offset of the image. 
    /// \return a new image as an QImage. 
    ///////////////////////////////////////////////////////////////////////// 
    QImage setX(int x);

2010-05-12 20:16:11

1

可以使用的樣式您需要HeaderDoc。

下面是一個例子。

/*! 
This is a method. 

@param param1 This is first parameter. 

@result 
This method returns nothing. 

@discussion 
This is an example. 


*/ 
- (void)someMethodWithParam1:(NSInteger)param1 
{ 
}

手冊：http://developer.apple.com/library/mac/#documentation/DeveloperTools/Conceptual/HeaderDoc/intro/intro.html

2010-10-04 05:11:26 Eonil

1

正如喬恩斯基特說，最流行的方法是Doxygen的，從我目前可以告訴，註釋的格式是AppleDoc基本上互操作。

此外，一定要檢查出的評論生成插件，弗雷德·麥肯寫道： http://www.duckrowing.com/2011/05/14/using-the-doxygen-helper-in-xcode-4/

他也有很大的如何，張貼寫Doxygen的意見： http://www.duckrowing.com/2010/03/18/documenting-objective-c-with-doxygen-part-i/

（這會更好作爲喬恩的回答評論，但唉，我沒有積分。）

2011-09-27 20:03:16

相關問題