Since Mys v1.3.2 is going to incorporate 5-10 times more library class files than in Mys v1.3.1, it becomes rather necessary to provide documentation for them. As you know, a class is designed to be easy to use/reuse in client code, with or without knowing its internal implementation. With a detailed user manual, it will be possible for aspiring site builders to manipulate existing library code and use them properly. This should enable more beginner and intermediate coders to create interesting features on their site. It should also be more convenient for future coders who plan to join the dev staff team, as the documentation will save them a huge amount of time getting used to our style. Anyway, once the wheel is there, you do not need to reinvent it.
So what does this look like? Well, the documentation system is not finalized yet and is actually still in its early stage, but a demo of user manual can be viewed from the url below. It was generated using PHPdocumentor, more documentation will come as we are approaching closer to Mys v1.3.2's release date:
http://www.mysidiaadoptables.com/docs/phpdocumentor/html/Core/Mysidia.html
In the example documentation, the class Mysidia is defined as a subclass of abstract class Core. Its constants, properties and methods are displayed in alphabetic order(only public properties and methods are listed). Some methods are difficult to understand and thus require more explanation, while others are quite simple to grasp. If you are a beginner or intermediate coder, there is no need to worry about what the source code of Mysidia class look like. All you need to know is to understand how to play with its properties and methods. Of course basic object-oriented programming skills are required to interpret what I am talking about.
At this point I have yet to figure out how to add sample code to the documentation, but once I figure this out it will be even easier for people to understand how to use Mysidia library code. The coding standard for Mysidia Adoptables has been changing since Mys v1.3.0, we plan to stabilize it by the major release Mys v1.4.0. This implies that until Mys v1.4.0 is available, you will see lots of drastic changes in our coding structure. This can prove to be quite difficult for Mod/plugin design, but we have to pay a price for future sustainable development. The direction towards OOP is inevitable as a project expands.
Hall of Famer
So what does this look like? Well, the documentation system is not finalized yet and is actually still in its early stage, but a demo of user manual can be viewed from the url below. It was generated using PHPdocumentor, more documentation will come as we are approaching closer to Mys v1.3.2's release date:
http://www.mysidiaadoptables.com/docs/phpdocumentor/html/Core/Mysidia.html
In the example documentation, the class Mysidia is defined as a subclass of abstract class Core. Its constants, properties and methods are displayed in alphabetic order(only public properties and methods are listed). Some methods are difficult to understand and thus require more explanation, while others are quite simple to grasp. If you are a beginner or intermediate coder, there is no need to worry about what the source code of Mysidia class look like. All you need to know is to understand how to play with its properties and methods. Of course basic object-oriented programming skills are required to interpret what I am talking about.
At this point I have yet to figure out how to add sample code to the documentation, but once I figure this out it will be even easier for people to understand how to use Mysidia library code. The coding standard for Mysidia Adoptables has been changing since Mys v1.3.0, we plan to stabilize it by the major release Mys v1.4.0. This implies that until Mys v1.4.0 is available, you will see lots of drastic changes in our coding structure. This can prove to be quite difficult for Mod/plugin design, but we have to pay a price for future sustainable development. The direction towards OOP is inevitable as a project expands.
Hall of Famer
Forum Contains New Posts
Forum Contains No New Posts
