0chain / 0chain/HelloWorld-iOS

documentation 📄

未关闭
#4 0 条评论 0 个 reaction 已指派 1 人 已被 @vijay-kachhadiya 认领 在 GitHub 查看
documentation
主要语言
Objective-C
星标
0
派生
1
PR 合并指标
30 天内没有已合并 PR

描述

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/

贡献指南

这个仓库没有索引到贡献指南

调研方向

该 issue 要求为整个 iOS 应用程序提供全面的文档。首先探索仓库结构,以识别关键文件,特别是模型、方法、扩展和闭包。使用提供的 Swift 文档指南作为参考。检查现有代码以寻找模式,并按照示例添加文档。确保每个变量、参数和闭包都有文档记录,并且扩展包含使用示例。

由索引模型根据 Issue 内容生成。

评估

技术栈
objective-c, swift
领域
documentation
Issue 类型
文档
难度
3/5
预计耗时
1-2 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
30/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。