[ios/tutorial] Xcode 에서 주석을 통해 Documenting 하는 방법 [ios/tutorial] Xcode 에서 주석을 통해 Documenting 하는 방법 http://www.raywenderlich.com/66395/documenting-in-xcode-with-headerdoc-tutorial -Documenting 을 header 에 하는 것이 맞을까 implementation 에 하는 것이 맞을까 검색하던 중 좋은 자료를 찾아서 정리해보았다. -더 많은 디테일한 정보를 얻고 싶다면, 상단에 링크된 원문을 읽는 것이 추천된다. -HeaderDoc 이라는 녀석이 있는데, Xcode5 & iOS7 과 함께 발표된 추가기능이다.이 녀석은 command line tool 인데, code 에 있는 document 를 HTML 형태로 만들어준다.( 물론 지원하는 형태로 작성했.. 2017. 11. 16. [Kotlin Tutorial] Documenting Kotlin code [Kotlin Tutorial] Documenting Kotlin code 출처 : Kotlin in action 1. Writing Kotlin documentation comments -Java 의 Javadoc 만들 때와 비슷하다.Kotlin 의 것은 KDoc 이라 부른다. -KDoc 은 /** 로 시작하고 tag 는 마찬가지로 @ 로 시작한다.Javadoc 과의 가장 큰 차이가 있다면 HTML 대신 Markdown 을 사용한다는 것이다./** * Calculates the sum of two numbers, [a] and [b] */fun sum(a: Int, b: Int) = a+b 정의를 참조하려면 [ ] 안에 이름을 넣어주면 된다. cf) Markdown 은 text-to-HTML conve.. 2017. 9. 20. [Effective Java] 외부에 제공하는 모든 API 요소에 대해 문서화 주석을 넣자. [Effective Java] 외부에 제공하는 모든 API 요소에 대해 문서화 주석을 넣자. - 사용 가능한 API 라면 반드시 문서화해야 한다. 만일 문서화 주석 규칙에 친숙하지 않다면 배워야 한다. - API 를 문서화하려면, 외부에 제공하는 모든 클래스, 인터페이스, 생성자, 메소드, 필드의 선언부 앞에 문서화 주석을 넣어야 한다. 만일 어떤 클래스가 직렬화될 수 있다면 직렬화 형태도 문서화해야 한다. - 문서화 주석이 빠진 API 를 사용하는 것은 실망스럽고 에러가 생길 가능성이 많다. 유지보수 하기 쉬운 코드를 작성하려면 외부에 공개되지 않는 대부분의 클래스, 인터페이스, 생성자, 메소드, 필드에 대해서도 문서화 주석을 작성해야 한다. - 메소드의 문서화 주석에서는 메소드와 클라이언트 사이의 계.. 2017. 1. 23. 반응형 이전 1 다음
