ARCHIVES

태그

신고하기

상단 메뉴 페이지

기본 콘텐츠로 건너뛰기

[swift + jazzy] xcode 소스코드 문서화2

현재 프로젝트에서 적용한 옵션이다.

[커맨드 + 시프트 + . ] 하면 숨김 파일이 보인다. 야물파일 앞에 점이 있다.
아래의 두개 파일을 만들어 넣고, jazzy 하면 이쁘게 만들어 진다.

파일명 : .jazzy.yaml

내용: 모듈이름 부분을 프로젝트명으로 바꾸면 된다.

author: jhchoo
copyright: Copyright © -------- Co., Ltd. All Rights Reserved.

output: Docs
theme: fullwidth
documentation: ./*.md

clean: true
min_acl: internal

module: 모듈이름
xcodebuild_arguments:
- -workspace
- 모듈이름.xcworkspace
- -scheme
- 모듈이름
sdk: simulator

exclude:
- "**/ProgressView.swift"
- "**/AppDelegate.swift"
- "**/NavigatorView.swift"
- "**/CODABLE/**"

custom_categories:
- name: CONTROLLER
children:
- BaseViewController
- SplashViewController
- AgreementViewController
- MainViewController

- name: VIEWMODEL
children:
- DealerModel

- name: NAVIGATION
children:
- AppNavigator
- AppProvider

- name: NETWORK
children:
- HttpClient
- NetworkManager

- name: CUSTOMVIEWS
children:
- ProgressHUD
- ErsLocationManager
- ErsPopupManager

- name: CONFIGURATION
children:
- CallMalnager
- PermissionManager
- UserDefaultsManager

- name: COREDATA
children:
- CoreDataManager

- name: GoogleService
children:
- AnalyticsManager


도큐멘트 파일 : README.md
                        마크다운

프로젝트명
===========
프로젝트 간략 설명

## 알아야 할 사항
---
> 이 앱은 어쩌구 서비스 앱 입니다.

## 개발자 참고 문서
---
1. 프로그램 목록
2. 공통 문자열
3. Analytics 규칙

> <a href="https://docs.google.com/spreadsheets/" target="_blank" >개발자 참고 문서 이동</a>


### License
---
**jhchoo master**

댓글