iOS 프로젝트 인코딩 사양 문서
코드를 더욱 깔끔하게 하고 팀의 협조를 더욱 원활하게 하기 위해 개발 규범 문서를 지정하기 위해 개발 학생들은 본 문서를 자세히 읽고 일상적인 개발 과정에서 본 문서의 약속을 준수해야 한다.
1. 코드 카탈로그 구조
엔지니어링 코드는 x 디렉토리에 있는 각 단어의 시작 문자가 다음과 같이 대문자로 BT로 구성되어 있습니다.
├── ABcd
├── Post
├── Topic
│ └── Contronller
│ ├── BTTopicViewController
│ ├── x
│ ├── x
│ └── x
|
├── x
│ ├── x
│ ├── x
│ ├── x
│ ├── x
│ └── sx
|
├── Pods
|
├── Frameworks
논리 코드 코어 모듈 설명:
2. 코드 이름 지정 사양
2.1 클래스 이름 또는 프로토콜 이름
예를 들어 시스템의 NSString, NSDate,사용자 정의 컨트롤 BTAlertView 등;
1. BTBannerView
2. Button
1. BTPriaseButton
3. UIImageView
1. BTTapImageView
4. Gesture
5. Delegate
1. UILabel xxxLabel
2. UIButton xxxButton
3. UIImageView xxxImageView
4. UISwitch xxxxSwitch
5. UICollectionView xxxxCollectionView
6. UITableView xxxTableView
7. Array xxxArray
8. NSDictionary xxxDictionary
9. BOOL islike
10. Float
11. NSINteger
12. Block xxxBlock
1. icon_topic_addfollow //
2. bg_article_cell
3. empty_center_post //
4. icon_cm_xxxx // CM
5. line_xxx_xx //
6. dot_xx_xxx //
a. Notifacation
1. Notification :[Name of associated class] + [Did | Will] + [UniquePartOfName] + Notification
2. NSApplicationDidBecomeActiveNotification
3. NSTextViewDidChangeSelectionNotification
b. Dictionary KEY
c. NSUserDefault KEY k + + UDKey > BTUserNameUDKey / BTAppDeviceTokenUDKey
d. const , k: eg:NSString *const kDataComments = @"comments";
e.
f. loading startLoading ,endLoading
Category +Additions
- (void)addElement:(elementType)anObj;
- (void)removeElement:(elementType)anObj;
- (NSArray *)elements;
//poperty , ”is”
@property (assign, getter=isEditable) BOOL editable;
XCode의 documents 컴파일 대상을 직접 사용하면 주석에서 문서를 직접 추출할 수 있습니다.(appledoc을 설치해야 함) 이것은 주석을 작성할 때 특정한 규범에 부합하도록 요구한다. 추출된 주석
/**여기에 클래스에 대한 설명을 써서 클래스 정의의 맨 앞에 놓고 상세하게 말할 수 있습니다*/
함수 설명
가능한 한 바깥에 노출된 인터페이스마다 아래의 주석을 작성할 것을 요구한다
/**여기에 함수에 대한 설명을 쓰고, 좀 더 상세하게 말할 수 있다.
@brief 이것은 @param 매개 변수 1 설명 @param 매개 변수 2 설명 @return 반환값 설명 @exception 이상 1 설명 */
========== 아래의 주석을 XCode 오른쪽 아래 {} 라이브러리로 드래그하면 단축키를 설정할 수 있습니다 ================/**
@brief @param <> @param <> @return */
참고 자료https://developer.apple.com/library/content/documentation/Cocoa/Conceptual/CodingGuidelines/Articles/NamingBasics.html#//apple_ref/doc/uid/20001281-1001751-BBCFECGB
http://www.cnblogs.com/496668219long/p/4488512.html
이 내용에 흥미가 있습니까?
현재 기사가 여러분의 문제를 해결하지 못하는 경우 AI 엔진은 머신러닝 분석(스마트 모델이 방금 만들어져 부정확한 경우가 있을 수 있음)을 통해 가장 유사한 기사를 추천합니다:
다양한 언어의 JSONJSON은 Javascript 표기법을 사용하여 데이터 구조를 레이아웃하는 데이터 형식입니다. 그러나 Javascript가 코드에서 이러한 구조를 나타낼 수 있는 유일한 언어는 아닙니다. 저는 일반적으로 '객체'{}...
텍스트를 자유롭게 공유하거나 복사할 수 있습니다.하지만 이 문서의 URL은 참조 URL로 남겨 두십시오.
CC BY-SA 2.5, CC BY-SA 3.0 및 CC BY-SA 4.0에 따라 라이센스가 부여됩니다.