diff --git a/source/fusiondirectory/development/documentation/PHPDoc.rst b/source/fusiondirectory/development/documentation/PHPDoc.rst new file mode 100644 index 0000000000000000000000000000000000000000..dc8e1116d88c70d455d4d4aafbb7635d4d94cf3a --- /dev/null +++ b/source/fusiondirectory/development/documentation/PHPDoc.rst @@ -0,0 +1,28 @@ +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 diff --git a/source/fusiondirectory/development/documentation/index.rst b/source/fusiondirectory/development/documentation/index.rst new file mode 100644 index 0000000000000000000000000000000000000000..7dd5ca6589b4aced66b6c76a7c5ce05a81c281bd --- /dev/null +++ b/source/fusiondirectory/development/documentation/index.rst @@ -0,0 +1,10 @@ +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 diff --git a/source/fusiondirectory/development/index.rst b/source/fusiondirectory/development/index.rst index 9f76840c5e27ee729493dae639cf9298daddcefa..584616ada701dc82e1a7f2ebaf0312bd8b307fe0 100644 --- a/source/fusiondirectory/development/index.rst +++ b/source/fusiondirectory/development/index.rst @@ -9,3 +9,4 @@ Development codingstyle/index.rst writeplugin/index.rst api/index.rst + documentation/index.rst