Improve the PHPDocs
nash-ye opened this issue · comments
Momtaz Framework is for developers, We need to add more comments with the codes to explain every line in the project. a better functions or classes description is needed too.
If you have a good English skills this is for you :)
Can you send me a task to test ?
@HendKandeel thanks for your comment!
You can explore the framework source code and help with what you can. There are many functions need more PHPDocs data like @return,@param or better general description.
If you don't know what I mean by PHPDocs this is a good link to start
http://en.wikipedia.org/wiki/PHPDoc
I think for now, we should focus on the code and the other enhancements after that we have to define a standard for Momtaz. I have meant that we have to define code style, control structure, spaces, indents etc.
@KodeBurner I agree with you, this is not very important but we should add at least the basic information for each function to make better understanding.
The most thing that I care about it is the @return tag and Description.
Momtaz in general follow the WordPress Coding Standards
http://make.wordpress.org/core/handbook/coding-standards/
I will move this to 1.2 milestone.
Done for many functions around, Thanks a lot for Aboelabbas Shahwan !