Add conventions around PHP code in the project

[yann-eugone]

The addition of test agains documentation gave me more ideas about things I could check with tests

• Classes docblocks: every class / interface must have minimal description.
• Public methods dockblocks: every public method must have minimal description.
• Package dependencies usage and declaration: every package must declare explicitely the dependency they are using.
• Source dependencies synchronisation: the main repository must be synchronized with all packages.

[codecov]

Codecov Report

Merging #68 (f85bc1e) into 0.x (f84309f) will not change coverage.
The diff coverage is 100.00%.

@@             Coverage Diff             @@
##                 0.x       #68   +/-   ##
===========================================
  Coverage     100.00%   100.00%           
  Complexity       781       781           
===========================================
  Files            132       132           
  Lines           2005      2004    -1     
===========================================
- Hits            2005      2004    -1     

Impacted Files	Coverage Δ
src/batch-box-spout/src/Reader/HeaderStrategy.php	100.00% <ø> (ø)
...batch-box-spout/src/Reader/Options/SheetFilter.php	100.00% <ø> (ø)
...rc/batch-box-spout/src/Writer/WriteToSheetItem.php	100.00% <ø> (ø)
...trine-dbal/src/DoctrineDBALJobExecutionStorage.php	100.00% <ø> (ø)
src/batch-symfony-console/src/CommandRunner.php	100.00% <ø> (ø)
...atch-symfony-console/src/RunCommandJobLauncher.php	100.00% <ø> (ø)
src/batch-symfony-console/src/RunJobCommand.php	100.00% <ø> (ø)
...njection/CompilerPass/RegisterJobsCompilerPass.php	100.00% <ø> (ø)
...ramework/src/DependencyInjection/Configuration.php	100.00% <ø> (ø)
...rk/src/DependencyInjection/YokaiBatchExtension.php	100.00% <ø> (ø)
... and 32 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f84309f...f85bc1e. Read the comment docs.

[halundraN]

This is an old debate and it may not be necessary to reopen it here.

From my point of view, making comments systematic reminds me of what we did some years ago. If it brings a lot in some cases, we also inevitably end up with comments that paraphrase the signature of the methods and make the reading of the code more cumbersome.

Example :

• "Run a command asynchronously" on CommandRunner::runAsync()
• "yokai/batch Symfony Bundle" on YokaiBatchBundle
• "Get a parameter value." on JobExecution::getParameter()

It's good to have comments to explain the code but I have doubts about the facts of making them systematic.

It's just an opinion ;)

[yann-eugone]

Yeah you're right @halundraN !
My point is : most of the time, a comment is very welcome, but in some very rare spots it is 100% useless.
This is why I rather want this kind of test, because I'm able to set my own rules to decide whether a comment is required here.
I've already removed non public methods, accessors, ...
But I was not able to add the exceptions for the places you spotted here.

So again, yeah this might be boring at some very particular classes/methods, but most of the time it is good to add.