code documentation

CODE DOCUMENTATION

DEFINITION OF TERMS

What is Code ?

DEFINITION OF TERMS

What is Code ?

What is Documentation ?

DEFINITION OF TERMS

What is Code ?

What is Documentation ?

What is Code documentation ?  

REASONS FOR CODE DOCUMENTATION

You will be using your code months later You want people to use your code You want people to help out It makes your code better You want to be a better writer

HOW TO DOCUMENT CODE

Types of Documentation

Requirement documentation Commenting Mark-down/README.md End-User Documentation

Requirement documentation ?

Commenting ?

Commenting ?

Types Of Commenting Inline Commenting Descriptive Blocks

What is Mark-down ?

Basic writing for mark-down

Paragraphs Headings Block Styling textLists Code formatting

README.md file ?

What to write What problem your project solves A small code example A link to your code & issue tracker Frequently Asked Questions (FAQ) Information for people who want to contribute back Installation instructions Your project’s license

End-User Documentation ?

CONCLUSIONCode documentation is required for any project embarked on, for the benefit of the programmer and every other person involved.

A programmer that properly documents code will find the debugging process easier, even thou the problem isn’t fixed by them, it could be fixed by another programmer because the code could be easily understood because it was properly documented.

THANK YOU