Make it easy for other developers to understand how to use your code when you share it or make your own libraries.

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.

Highlight the input and output (parameters and return values) of your methods.Moreover, it’s the best place to highlight specific conditions, cases or requirements for your functions that have to be noted somewhere. Describe the purpose of the properties, functions and classes up to the level of detail that you desire.However by writing the proper documentation you can: I won’t disagree that writing proper and comprehensive documentation for every single property, function, class, struct, or anything else that exists in a project is not an easy job. Even though it seems that it stalls the development process, it’s actually a part of it. However, if you’re still interested in the old-style documenting style, take a look in our previous tutorial.ĭocumenting the code is an extremely important task for every developer. The new Markdown-enabled documentation style, as the new one has several advantages: It provides greater level for customizing the text, it’s more flexible, and of course, more interesting. With the introduction of Xcode 7, developers can use the powerful Markdown syntax to apply rich text formatting to the text of their documentation, which in combination to specific keywords that indicate special parts (like parameters, function results, etc) can result to an amazing outcome. Amongst all the features Xcode 7 incorporates, there is one that admittedly distinguishes that is the new revolutionary, much better way to write code documentation.

Macdown python code