> For the complete documentation index, see [llms.txt](https://ojsde.gitbook.io/ojs-how-to-start/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ojsde.gitbook.io/ojs-how-to-start/code-conventions.md).

# Code conventions

Have a look at these: <https://www.php-fig.org/>

## How to write comments for classes

`@ingroup` all files in a plugin are in a group (naming convention: ...)

`@see` use this to link to the parent function if you changed the parameters or description of the function

`@copydoc` use this to copy the documentation of the parent function

see for more details <https://www.stack.nl/~dimitri/doxygen/manual/commands.html>

## Dos and don'ts

If possible try not to use the static `Request::` but `$this->getRequest()`.