Xcode 코드 설명서

Question

XCode로 작성된 코드를 문서화하는 방법에 대한 지침/표준이 있습니까? 다른 사람들이 쉽게 이해할 수 있도록하려면 코드를 문서화하는 방법이 있습니까? Xcode는 코드 + 주석의 API 참조 문서와 같은 문서를 자동으로 생성하는 데 사용할 수있는 도구를 제공합니까?

적어도 코드에 정의 된 인터페이스/프로토콜/메소드 앞에 주석을 쓰는 표준 방법이 있는지 이해하고 싶습니다. 나는 다음처럼 지시어를 사용하여 본 적이 있지만 나는 그들이 어떻게 작동하는지 이해하지 못했다 :

#pragma mark - 
#pragma mark Initialization 

Answer 1

당신은 하나에 두 선을 병합 할 수 있습니다 : #pragma mark - Initialization를. 방법 목록 (위, 오른쪽)을 클릭하면 선이 굵은 머리글이 표시됩니다. 그것은 섹션의 메소드를 그룹화하는 표시입니다.

위의 Derek가 게시 한 코딩 지침 링크는 반드시 읽어야합니다.

Apple과 유사한 문서를 만들려면이 우수하고 무료 인 타사 도구를 사용해야합니다. http://www.gentlebytes.com/appledoc/ Apple은 그와 비슷한 것을 제공하지 않습니다.

---

pragma는 컴파일러에 힌트를 전달하는 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를 가지고 있으며 주석보다 낫습니다. 당신이 바로 가기 키에 바인더 제본 프라그 마를 코드 조각을 원하는 경우에, 사용

#pragma mark - <#Description#> 

그래서 수있는 설명 텍스트에 탭 점프. pragma에 대한

더 :

• What is a pragma?
• 6.56 Pragmas Accepted by GCC
• 연타의 당신이 매크로의 프라그 마를 생성 할 수 있기 때문에 Controlling Diagnostics via Pragmas
• Function attributes이 pragma를 선호하고 프라그 마를가 다른 의미가있을 수 있습니다 다른 컴파일러.

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.*/ 
}