iOS 프로젝트 인코딩 사양 문서

3720 단어
=================================
코드를 더욱 깔끔하게 하고 팀의 협조를 더욱 원활하게 하기 위해 개발 규범 문서를 지정하기 위해 개발 학생들은 본 문서를 자세히 읽고 일상적인 개발 과정에서 본 문서의 약속을 준수해야 한다.

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 등;
  • 프로토콜 이름
  • 프로토콜 이름은 UIView-Hierarchy 파일의 UIView(Hierarchy) 이름과 같은 파일 이름을 참조합니다.
  • 사용자 정의 뷰 View
  •    1. BTBannerView
       2. Button
           1. BTPriaseButton
       3. UIImageView
           1. BTTapImageView
       4. Gesture
       5. Delegate
    
  • 사용자 정의 뷰 View
  • 시스템 구성 요소 속성 이름: 모두 약어 추가
  • 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
    
  • 리소스 파일 이름 iconcm_xxx_ (icon/bg/empty/line/dot/모듈 동작/이름)
  • 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;
    
  • 명명 상수(Constants) 한 그룹의 관련 상수를 정의하려면 매거 유형(enumerations)을 사용하고, 매거 유형의 명명 규칙과 함수의 명명 규칙이 같다
  • 2.2 함수명
  • 전체적인 것도 접두사를 달아야 한다.접두사 뒤의 첫 번째 자모는 대문자로 쓴다.뒤에 대소문자 믹스.예: BTscreenHeight()
  • 2.3 속성 이름 지정
    //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

    좋은 웹페이지 즐겨찾기