Swift 설명서 코멘트 사용방법
Swift 문서 설명에 대해 몇 가지 질문이 있습니다.
Apple 문서의 일부와 같이 관련 선언 섹션을 만들 수 있는 방법이 있습니까?예를 들어 I + Click를 할 때
tablewView(_:heightForRowAtIndexPath:)method, 그것은 나를 생성된 문서 내의 다른 세가지 관련 method에 연결합니다.스위프트에 경고문구가 있습니까?목적-C가 내가 할 수 있게 해준 건 알아요
@warning생성된 문서에 굵은 경고를 표시합니다.하지만,:warning:스위프트의 문서 댓글에 아무것도 표시되지 않아서 다른 방법이 없을까 궁금했습니다.제 설명서를 Apple 설명서와 비슷한 형식의 HTML 파일로 만드는 방법이 있습니까?나는 Eclipse와 같은 다른 IDE에서 내 코드에 대한 HTML 문서를 생성할 수 있다는 것을 알고 있습니다.엑스코드에 이런게 있나요?
이 답변은 Swift 5.7과 Xcode 14.x용으로 마지막으로 수정되었습니다.
DocC는 의견(추가 리소스)을 받아 Xcode로 보거나 웹에서 호스팅할 수 있는 풍부한 문서를 생성하는 Apple의 문서 컴파일러입니다.
문서 작성
유형///아니면/** */문서 설명을 시작한 다음 DocC의 특별한 방언인 Markdown을 사용하여 내용을 작성합니다.이 사투리는 많은 키워드를 지원합니다.- Parameters:함수 인수를 설명하기 위해 또는- Returns:반환 값을 설명합니다.
어떻게 그 방법을 주목할 것인지.> Warning:키워드는 옆으로 인식되어 자동으로 강조됩니다.DocC는 다음과 같은 여러 가지 다른 종류를 지원합니다.Note,Tip그리고.Important.
/// Produce a greeting string for the given `subject`.
///
/// ```
/// print(hello("world")) // "Hello, world!"
/// ```
///
/// > Warning: The returned greeting is not localized. To
/// > produce a localized string, use ``localizedHello(_:)``
/// > instead.
///
/// - Parameters:
/// - subject: The subject to be welcomed.
///
/// - Returns: A greeting for the given `subject`.
func hello(_ subject: String) -> String {
return "Hello, \(subject)!"
}
기호로 연결
DocC는 이중 백틱으로 래핑된 기호를 자동으로 링크(및 자동 완성!)합니다.``. 동일한 유형의 관련 기호 또는 동일한 모듈의 다른 유형으로 연결할 수 있습니다.
링크는 공용 기호와 하나의 모듈로만 제한됩니다.현재로서는 예를 입력할 방법이 없습니다.``UIView``그리고 DocC가 UIKit의 문서에 자동으로 연결하도록 합니다.
웹 페이지 생성 중
DocC는 문서를 웹페이지로 내보낼 수 있도록 지원합니다.먼저 Product → Build Documentation을 선택하여 설명서를 컴파일해야 합니다.설명서가 작성되면 [더보기] 단추를 눌러 보관 파일을 내보냅니다.보관에는 서버에서 호스트할 수 있는 전체 문서 웹 페이지가 포함됩니다.
위 과정은 조금 복잡하기 때문에 자동화를 도와줄 수 있는 도구가 많습니다.Apple은 Swift 패키지 또는 Xcode 프로젝트에 추가하고 모든 빌드에서 실행되도록 구성할 수 있는 swift-docc-plugin을 제공합니다.CI에서도 이 프로세스를 자동화할 수 있습니다.
더보기
DocC에 대해 자세히 알아보려면 다음 가이드를 읽는 것이 좋습니다.
Xcode 7.0 베타 4
표기법이 변경되었습니다(:param:더 이상 작동하지 않음...).
/// Creates the string representation of the poo with requested size.
///
/// - warning: Be carefull! Poos can hurt.
/// - parameter size: requested size of the poo
/// - returns: string representation of the poo
func makePoo(size: String) -> String
{
return "Ouch. This is \(size) poo!"
}
그리고 다음과 같습니다.
둘 중 하나를 사용할 수 있습니다.///아니면/** */
이것을 코드 조각으로 추가하려는 사람들을 위한 것입니다.스위프트 5, X코드 11.3+
이것은 에 추가된 것입니다: 이 스레드에서 Yogendra Singh의 답변입니다.
/**
<#Summay text for documentation#>
- parameter <#parameterName#>: <#Description#>.
- returns: <#Return values#>
- warning: <#Warning if any#>
# Notes: #
1. <#Notes if any#>
# Example #
```
// <#Example code if any#>
```
*/
위의 코드를 Xcode로 복사하여 붙여넣습니다.코드를 선택한 다음 마우스 오른쪽 단추를 누릅니다.
코드 조각을 저장하고 완료 이름을 설명서로 지정합니다.
이제 문서 입력을 시작하면 코드 완료에 스니펫이 표시됩니다.
문서 설명의 경우 다음 표기법을 사용합니다.
/**
This method sum two double numbers and returns.
Here is the discussion. This methods adds two double and return the optional Double.
- parameter number1: First Double Number.
- parameter number2: Second Double Number.
- returns: The sum of two double numbers.
# Notes: #
1. Parameters must be **double** type
2. Handle return type because it is optional.
# Example #
```
if let sum = self.add(number1: 23, number2: 34) {
print(sum)
}
```
*/
func add(number1: Double, number2: Double) -> Double? {
return number1 + number2
}
Xcode의 키보드 단축키
option + cmd + /
(3) HTML로 당신의 문서를 생성하거나 심지어 문서 집합을 생성하기 위해서, 나는 그러한 목적으로 만들어진 jazzy를 강력하게 추천합니다.
WIP라고 해도 애플 문서와 유사한 프레젠테이션으로 문서를 생성하고 정말 잘 작동합니다.
언급URL : https://stackoverflow.com/questions/27715933/how-to-use-swift-documentation-comments
'sourcecode' 카테고리의 다른 글
| mysql 테이블에서 특정 행 선택 (0) | 2023.10.05 |
|---|---|
| moment.js 24h 형식 (0) | 2023.09.25 |
| Git에서 무시된 디렉터리의 하위 디렉터리 무시 (0) | 2023.09.25 |
| 임시 폴더 단어 누락 업로드 누르기 (0) | 2023.09.25 |
| -D_DEFAULT_SOUR는 무엇을 합니까? (0) | 2023.09.25 |