10 Pieces of PHP Developer Advice in 2022: Advice #3: Share Reusable Classes with Simple Documentation and Example Code - 3 minutes - Lately in PHP Podcast Episode 90 Part 3

In this article you can learn:

1. Previous article: Be a Good Community Member Sharing Your Open Source Work in Community Sites

2. Previous article: Use a Readable PHP Coding Style

3. This article: Share Reusable Classes with Simple Documentation and Example Code

4. Next: Share Nice Tutorial Articles to Help Other Developers Learn Step by Step

Contents

Sharing PHP code just by itself may not be as useful if other people find it hard to understand. This may happen if you have written complex components.

Therefore, you must share some documentation and example files that others can learn without reading the whole code you have shared.

Documentation in HTML format is fine, as you can read it in a Web browser. Nowadays, the Markdown format has become very popular because it can be easily read in the text editor. It can also be rendered as an HTML page, so it can look nicer and easier to navigate using links and other rich text formatting possibilities.

4. Next: Share Nice Tutorial Articles to Help Other Developers Learn Step by Step

• Example package with simple examples and documentation
• Markdown format
• Markdown documentation
• Example of online Markdown editor