CFSDN nhấn mạnh vào giá trị tạo ra nguồn mở và chúng tôi cam kết xây dựng nền tảng chia sẻ tài nguyên để mọi nhân viên CNTT có thể tìm thấy thế giới tuyệt vời của bạn tại đây.

Bài viết trên blog CFSDN về hướng dẫn quy ước đặt tên để phát triển các dự án iOS này được tác giả sưu tầm và biên soạn. Nếu các bạn quan tâm đến bài viết này thì nhớ like nhé.

Lời nói đầu.

Việc tuân thủ các thông số kỹ thuật cũng giúp mã rõ ràng hơn, dễ đọc hơn, dễ sử dụng hơn, dễ bảo trì hơn và có thể thích ứng tốt hơn với việc phát triển nhóm. Nhìn vào cũng thấy thích mắt, vậy tại sao không làm. Không cần nói nhiều ở phần dưới đây, hãy cùng xem phần giới thiệu chi tiết nhé.

1. Về tài liệu này.

1. Mục đích viết tài liệu này.

    Mục đích của việc viết "Đặc tả đặt tên cho các dự án iOS" là để cho phép các nhà phát triển iOS tiếp theo tham gia vào dự án đọc tài liệu này để hiểu các yêu cầu đặt tên trong mã của dự án iOS hiện tại và tuân thủ nghiêm ngặt tài liệu này để đảm bảo rằng mã đó là đúng. được cập nhật. Dễ đọc và bảo trì.

2. Phạm vi sử dụng của tài liệu này.

   "Thông số kỹ thuật đặt tên cho dự án iOS" là bắt buộc trong dự án iOS. Thay thế wsf hoặc wsf trong bài viết này bằng tiền tố đại diện cho dự án (vui lòng sử dụng ba chữ in hoa) và nó có thể được sử dụng cho các dự án iOS khác.

3. Người chịu trách nhiệm cập nhật văn bản này.

    "Tiêu chuẩn đặt tên cho dự án iOS" được hình thành thông qua thảo luận, trao đổi giữa ID này và đồng nghiệp, ID này chịu trách nhiệm chỉnh sửa, sửa đổi và cập nhật phiên bản tiếp theo.

2. Cấu trúc thư mục.

3. Tạo [Thư mục Mô-đun Kinh doanh] mới.

1. Tên thư mục cần thể hiện tóm tắt chức năng của mô-đun.

Ví dụ: hệ thống thanh toán, đặt hàng.

2. Các thư mục phụ được đặt tên theo mẫu thiết kế lập trình và các từ cần chọn trong các từ sau:

viewmodel、model、view、viewcontroller、Xem thêm 。

4. Tạo một [danh mục con] mới.

1. Tên lớp.

(1) Thực hiện theo danh pháp trường hợp lạc đà lớn.

(2)wsf+tên tóm tắt mô-đun+tên phân vùng chức năng+hậu tố thông thường của lớp cha. Ví dụ: wsforderlistvc.

(3) Để giữ cho toàn bộ mã dự án sạch sẽ và thống nhất, nên sử dụng các từ danh sách, chi tiết, tin nhắn, tview, cell, vc, tvc, vm, v.v.

(4) Tên mô-đun tóm tắt phải là tên mô-đun đại diện thống nhất, rõ ràng và duy nhất.

(5) Hậu tố thành ngữ của lớp cha có nghĩa là: Nếu bạn muốn kế thừa một lớp con từ các khung công tác khác, bạn phải tuân theo quy ước đặt tên của nó. Ví dụ: tên của lớp con kế thừa uiview phải kết thúc bằng view.

2. Tên thuộc tính.

(1) Thực hiện theo phương pháp đặt tên dạng lạc đà nhỏ và tránh viết tắt.

(2) Hậu tố phản ánh kiểu dữ liệu của thuộc tính. Ví dụ: orderpricelabel, orderlimitsarray.

(3) Sử dụng hướng dẫn đặt tên dài và mang tính mô tả. Ví dụ: settingbutton thay vì setbtn.

(4) Yêu cầu nsstring *namestring; thay vì nsstring* namestring; hoặc nsstring * namestring;.

3. Định nghĩa thuộc tính.

(1) Sắp xếp các tham số trong các thuộc tính đã xác định: tính nguyên tử, đọc và ghi và quản lý bộ nhớ. Ví dụ: @property (nonatomic, readwrite, copy) nsstring *namestring,

(2) Các thuộc tính kiểu Bool cần phải có tiền tố is cho các phương thức getter của chúng. Phương thức getter được đặt phía trước hạn định quản lý bộ nhớ, ví dụ: @property (nonatomic, readonly, getter=iseditable, Gán) bool editable,

4. Tên biến thể hiện.

(3) Bắt đầu bằng dấu gạch dưới.

(2) Thực hiện theo phương pháp đặt tên dạng lạc đà nhỏ và tránh viết tắt.

(3) Hậu tố phản ánh kiểu dữ liệu của thuộc tính. Ví dụ: _orderpricelabel, _orderlimitsarray.

5. Tên phương thức công khai.

(1) Thực hiện theo phương pháp đặt tên dạng lạc đà nhỏ và tránh viết tắt.

(2) Không dùng từ “và”, không nên dùng để làm rõ rằng có nhiều tham số.

6. Tên phương thức riêng.

(1) Thực hiện theo phương pháp đặt tên dạng lạc đà nhỏ và tránh viết tắt.

(2) Lớp cha trực tiếp là khung cacao: bắt đầu bằng p_.

(3) Lớp cha trực tiếp là một khung khác: bắt đầu bằng tiền tố nhất quán (chữ thường) + dấu gạch dưới hoặc wsf_ của chính nó. Ví dụ: abc_, wsf_.

7. Hàm thuần C.

(1) Thực hiện theo phương pháp đặt tên dạng lạc đà nhỏ và tránh viết tắt.

(2) Thêm wsf làm tiền tố.

8. Biến toàn cục.

tập tin .h.

tập tin .m.

(1) Thực hiện theo danh pháp trường hợp lạc đà và tránh viết tắt.

9. Tên điều tra.

(1) Thực hiện theo danh pháp trường hợp lạc đà và tránh viết tắt.

(2) Sử dụng phương pháp liệt kê oc.

(3) Tên đối tượng liệt kê: wsf+tên tóm tắt phạm vi liệt kê+loại. Ví dụ: wsfalipayresultcodetype.

(4) Tên loại liệt kê: wsf+tên tóm tắt phạm vi liệt kê+tên tình huống loại_chắc chắn. Ví dụ: wsfalipayresultcodetype_success.

10. Tên Hiệp định.

(1) Thực hiện theo danh pháp trường hợp lạc đà và tránh viết tắt.

(2) Giao thức đại lý: tên lớp + đại biểu. Ví dụ: wsforderlistchangeddelegate.

(3) Giao thức nguồn dữ liệu: tên lớp + nguồn dữ liệu. Ví dụ: wsforderlistdatasource.

(4) Giao thức thông thường: tên lớp + giao thức. Ví dụ: wsforderlistvcprotocol.

5. Tạo [Danh mục] mới.

1. Tên danh mục.

(1) Tên lớp + tiền tố nhận dạng + nhận dạng mở rộng.

(2) Thực hiện theo danh pháp trường hợp lạc đà và tránh viết tắt.

(3) wsf hoặc chính bạn luôn sử dụng tiền tố (chữ hoa) + dấu gạch dưới làm tiền tố. Ví dụ: nsstring (wsf_httpmanager), nsstring (abc_httpmanager).

2. Tên phương thức.

(1) Thực hiện theo phương pháp đặt tên dạng lạc đà nhỏ và tránh viết tắt.

(2) wsf hoặc chính bạn luôn sử dụng tiền tố (chữ thường) + dấu gạch dưới làm tiền tố. Ví dụ: - (void)wsf_urlencodedstring;, - (void)abc_urlencodedstring,

6. Tạo [Thỏa thuận] mới.

1. Tên thỏa thuận.

(1) Thực hiện theo danh pháp trường hợp lạc đà và tránh viết tắt.

2. Tên phương thức.

(1) Thực hiện theo phương pháp đặt tên dạng lạc đà nhỏ và tránh viết tắt.

(2) Nếu đó là giao thức proxy, hãy bắt đầu tên phương thức proxy bằng tên lớp của đối tượng gửi proxy (xóa tiền tố của tên lớp và làm theo phương pháp đặt tên kiểu chữ lạc đà).

7. Tạo [Gói thư viện bên thứ ba] mới.

(1) Quản lý thủ công: Ví dụ: khi sử dụng khung mjrefresh, bạn cần thêm tiền tố vào tất cả các tên lớp của nó để tránh xung đột không gian tên. Ví dụ: có tên wsfmjrefresh.

(2) Quản lý quả: Không cần xử lý đặc biệt.

8. Tạo một [hằng số] mới.

1. Hằng số riêng.

tập tin .m.

2. Hằng số công khai.

tập tin .h.

tập tin .m.

minh họa:

(1) Thực hiện theo phương pháp đặt tên dạng lạc đà nhỏ và tránh viết tắt.

(2) Khi khai báo các hằng public, bạn cũng có thể sử dụng Foundation_export để thay thế extern.

3. Các phương pháp đặt tên phổ biến cho tên hằng: Nếu hằng số được giới hạn ở một "đơn vị biên dịch" nhất định, tức là "tệp triển khai", hãy thêm chữ k vào phía trước nếu hằng số hiển thị bên ngoài lớp thì thường là như vậy; được đặt tên là tiền tố wsf+class.

9. Tạo [Thông báo] mới.

1. Xử lý theo phương pháp hằng số công khai.

2. Sử dụng thông báo làm hậu tố.

Tóm tắt.

Trên đây là toàn bộ nội dung bài viết mong rằng nội dung bài viết có giá trị tham khảo và học tập nhất định cho quá trình học tập, làm việc của mọi người. Nếu có thắc mắc gì có thể để lại tin nhắn để trao đổi. .

Liên kết gốc: http://www.cnblogs.com/cchHers/p/7887579.html.

Cuối cùng, bài viết về hướng dẫn quy ước đặt tên phát triển của các dự án iOS kết thúc tại đây. Nếu bạn muốn biết thêm về hướng dẫn quy ước đặt tên phát triển của các dự án iOS, vui lòng tìm kiếm bài viết CFSDN hoặc tiếp tục duyệt các bài viết liên quan. trong tương lai blog của tôi! .