0chain / 0chain/HelloWorld-iOS
documentation 📄
- Ngôn ngữ chính
- Objective-C
- Star
- 0
- Fork
- 1
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Mô tả
add documentation of entire application.
- methods should have parameter documentation
- swift closures should be closing brace indictor
- extensions should have examples
- models should have every variable documented
references:
https://sarunw.com/posts/swift-documentation/
Hướng dẫn đóng góp
Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này
Hướng nghiên cứu
Issue yêu cầu tài liệu toàn diện cho toàn bộ ứng dụng iOS. Hãy bắt đầu bằng cách khám phá cấu trúc kho lưu trữ để xác định các tệp quan trọng, đặc biệt là các model, phương thức, extension và closure. Sử dụng hướng dẫn tài liệu Swift được cung cấp làm tài liệu tham khảo. Kiểm tra mã hiện có để tìm các mẫu và thêm tài liệu theo các ví dụ. Đảm bảo mỗi biến, tham số và closure đều được ghi chép, và các extension bao gồm các ví dụ sử dụng.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- objective-c, swift
- Lĩnh vực
- documentation
- Loại issue
- Tài liệu
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 30/100