Xcodeコードのドキュメント

Question

XCodeで書かれたコードを文書化する方法に関するガイドライン/標準はありますか？つまり、他の人がわかりやすいようにしたいのであれば、コードを文書化する方法はありますか？ Xcodeは、コード+コメントからAPIリファレンスドキュメントのようなドキュメントを自動的に生成するために使用できるツールを提供していますか？

少なくとも、コードに定義されているインタフェース/プロトコル/メソッドの前にコメントを書く標準的な方法があるかどうかを理解することに興味があります。私は、次のいずれかのようディレクティブを使用して見てきましたが、私は、彼らがどのように動作するか理解していなかった。

#pragma mark - 
#pragma mark Initialization 

Answer 1

あなたは1に、これらの2つの行をマージすることができます：#pragma mark - Initializationを。メソッドリスト（上、右）をクリックすると、太字のヘッダーと線が表示されます。これは、セクション内のメソッドをグループ化するためのマーカーに過ぎません。

上記のDerekによって掲載されたコーディングガイドラインは必須です。

アップルのようなドキュメントを作成するには、この優れた無料のサードパーティ製のツールを使用する必要があります。http://www.gentlebytes.com/appledoc/アップルはそれに近いものを提供していません。

---

プラグマは、ヒントをコンパイラに渡すためのISO C機能です。

XCode（AFAIK）でのプラグマの追加はmarkで、-および/またはテキストのみです。メソッドファインダに線や太字のテキストが作成されます。

// MARK: - random text 
/* MARK: more random text */ 

しかし、私はの#pragmaを使用する：あなたはGCCでコンパイルしていない言語でファイルを編集する場合

// Mark a section in your code with a line and a bold text. 
// You can use the line or the text alone. 
#pragma mark - random text 

は、あなたはまだ（これはあまりにもGCC言語のために働く）のコメントにマークを使用することができます私の色のテーマには赤のプラグマがあり、コメントよりも優れているからです。あなたがホットキーにバインドさプラグマコードスニペットをしたい場合は、説明テキストにそうすることができますタブジャンプ

#pragma mark - <#Description#> 

を使用しています。プラグマについて

より：

• What is a pragma?
• 6.56 Pragmas Accepted by GCC
• クランのあなたは、マクロからプラグマを生成することはできませんのでControlling Diagnostics via Pragmas
• Function attributesがプラグマに好まれ、プラグマが上の異なる意味を持っているかもしれません別のコンパイラ。

Answer 2

@ janoの答えに加えて、以下のフォーマットを使用してメソッドの機能を説明します。

/*! 
@function  getEmployeeDetails 
@abstract  getEmployeeDetails 
@discussion  This function will fetch employee details based on employee id 
@param   strEmpId 
employee unique id 
@result   an Array of Employee 
*/ 

-(NSArray*)getEmployeeDetails:(NSString *)strEmpId{ 
    /*Do somethings.*/ 
}