实际上是问题(从开发人员的角度和用 Swift / Objective C 编写代码的角度来看)。是否有任何普遍接受的标准来维护此类记录?
在我工作的公司中,一切都仅限于以任意风格(作为文本文件)对项目(和项目架构)的简要描述、任务管理器中的任务以及代码中的注释(在代码的开头)文件,并且在非直观函数的情况下 - 函数之前)。
同时,使用 Swagger 及其类似物记录了 RESTful 服务器代码(输出是一个迷你网站,其中包含所有请求和参数的描述)。
欢迎任何关于该主题的回复。
实际上是问题(从开发人员的角度和用 Swift / Objective C 编写代码的角度来看)。是否有任何普遍接受的标准来维护此类记录?
在我工作的公司中,一切都仅限于以任意风格(作为文本文件)对项目(和项目架构)的简要描述、任务管理器中的任务以及代码中的注释(在代码的开头)文件,并且在非直观函数的情况下 - 函数之前)。
同时,使用 Swagger 及其类似物记录了 RESTful 服务器代码(输出是一个迷你网站,其中包含所有请求和参数的描述)。
欢迎任何关于该主题的回复。
查看自动代码文档,例如 jazzy: https ://github.com/realm/jazzy
我们使用 Confluence 来记录文档。
来自 Wikipedia:供组织内部使用以创建统一知识库的 wiki 系统。
优点:在访问、填写和维护有关项目的最新信息方面是一个方便的工具。
缺点:需要手动维护信息的相关性。