[iOS] documentation

1. ObjC

1줄의 경우(주로 변수)

@property (nonatomic, assign) CGFloat angle;    ///< 각도

위에다 쓸 경우(주로 함수)

/**

 @brief size값중 더 짧은 값을 반환하는 함수

 @param size CGSize

 @return CGFloat size값중 더 짧은 값

 */

+ (CGFloat)getMinLength : (CGSize)size;

2. swift

1줄의 경우(주로 변수)

/// default birthday 문구

let defaultBirthdayString = "yyyy.mm.dd"

위에다 쓸 경우(주로 함수)

     /**

     두 점 사이의 거리를 구하는 함수

     - parameter firstPoint : 첫번째 점

     - parameter secondPoint : 두번째 점

     - returns : CGFloat : 두 점 사이의 거리

     */

    func calculateDistance(_ firstPoint:CGPoint, _ secondPoint:CGPoint) ->CGFloat

위와 같이 documentation을 활용하면 개발할 때 혹은 소스를 전달할때 좀 더 편하게 일 할 수 있다.

안해서 문제지...