Skip to content

Documentation

Jump to bottom
akifuji edited this page Aug 21, 2018 · 2 revisions

Docs

Excellent documentation is very helpful for all developers and us!!
Find docs issues and feel free to write them:pencil2:

Here is a quote from Documenting Swift Code in Xcode Using Markdown and Jazzy.
When you write docs, please check these points:sparkles::sparkles::sparkles:

  • Describe the purpose of the properties, functions and classes up to the level of detail that you desire. Moreover, it’s the best place to highlight specific conditions, cases or requirements for your functions that have to be noted somewhere.
  • Highlight the input and output (parameters and return values) of your methods.
  • Remember without any hassle what each function is meant to do and what each property is for when you revisit a project months after its initial implementation.
  • Make it easy for other developers to understand how to use your code when you share it or make your own libraries.

Furethermore, these resources might be helpful!

The best way to generate docs is Realm’s jazzy. If yor are interested in it, install and run it:thumbsup:

Clone this wiki locally