Skip to content
GitLab
Explore
Projects
Groups
Topics
Snippets
Projects
Groups
Topics
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
fusiondirectory
dev-manual
Commits
3d7948b3
Verified
Commit
3d7948b3
authored
2 months ago
by
dockx thibault
Browse files
Options
Download
Patches
Plain Diff
First commit - comment how to in code
Comment how to in code p1
parent
db257823
dev
92-migration-explain-how-obsolete-work-in-the-dev-manual-and-update-our-logic
No related merge requests found
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
source/fusiondirectory/development/documentation/PHPDoc.rst
+28
-0
source/fusiondirectory/development/documentation/PHPDoc.rst
source/fusiondirectory/development/documentation/index.rst
+10
-0
source/fusiondirectory/development/documentation/index.rst
source/fusiondirectory/development/index.rst
+1
-0
source/fusiondirectory/development/index.rst
with
39 additions
and
0 deletions
+39
-0
source/fusiondirectory/development/documentation/PHPDoc.rst
0 → 100644
+
28
−
0
View file @
3d7948b3
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
This diff is collapsed.
Click to expand it.
source/fusiondirectory/development/documentation/index.rst
0 → 100644
+
10
−
0
View file @
3d7948b3
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
This diff is collapsed.
Click to expand it.
source/fusiondirectory/development/index.rst
+
1
−
0
View file @
3d7948b3
...
@@ -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
This diff is collapsed.
Click to expand it.
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment
Menu
Explore
Projects
Groups
Topics
Snippets