Swift mark down 활용하기

• mark up
  "(mark) 또는 tag로 둘러싸인 언어로써 문서나 데이터의 구조를 명기하는 언어이다.

• mark down
  작성한 텍스트를 Mark up으로 변환해주는 언어.
  swift 에선 /// 또는 /***/를 이용한다.

공식문서 : https://swift.org/documentation/api-design-guidelines/

Swift.org

참고 : https://nsios.tistory.com/63

[Swift] MarkUp Overview Documentation 작성하기 (설명문서작성)

 

 

//mark 1
///- parameter name: 이름
///- parameter age: 나이
func myFunction(name: String, age: Int){}

//mark 2
/// - parameters:
///     - name: 이름
///     - age: 나이
func myFunction2(name: String, age: Int){}

//mark 3
/**
 - parameters:
    - name: 이름
    - age: 나이
 */
func myFunction3(name: String, age: Int){}

//mark 4
/**
[internet link](https://greensky0026.tistory.com/)

nomal text

 *italic text*

 **bold text*

 `straight? text z`
 
 * list 1
 * list 2

 ~~~
 // you can write code here
 let key: String = "swift"
 let value: 1
 ~~~

 - Parameters:
    - key : programming langauge
    - value : number

 - Throws : error

 - Returns : return value

 - Important : important things

 - note : just note

 - version : 1.0.0
 */
func manyMarkdown(key: String, value: Int){}