Verified Commit 3d7948b3 authored by dockx thibault's avatar dockx thibault
Browse files

:sparkles: First commit - comment how to in code

Comment how to in code p1
Showing with 39 additions and 0 deletions
+39 -0
Doxygen
=======
We are using a tool named doxygen which is fantastic to read documented code and offers a visual
reprensentation of the interaction of classes and methods.
If well documented, the visuals helps to quicker understand the codes.
How to document your code
-------------------------
**Within your methods**
You may comment your code inline above your line of code in order to make a clear message on what/why/how
your below code is performing.
**Above your methods**
We use PHPdoc to get an harmonious documentation withing the code.
It basically start like this :
/**
* Your comment here.
*/
Within that comment block we defined : variables and return types.
We mandate our developpers to use strict type and we enforce it in php 8.2+
On tope of your
\ No newline at end of file
Writing documentation within your code
=======================================
You can properly write documentation within your code.
This is our guidelines
.. toctree::
:maxdepth: 2
PHPDoc
\ No newline at end of file
...@@ -9,3 +9,4 @@ Development ...@@ -9,3 +9,4 @@ Development
codingstyle/index.rst codingstyle/index.rst
writeplugin/index.rst writeplugin/index.rst
api/index.rst api/index.rst
documentation/index.rst
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment