Missing function/class method doc comment PHP-D1002
Documentation
Minor
2 years ago
—
2 years old
Doc comment missing for function
decrypt 57 }
58}
59
60function decrypt(string &$encryptedFileRaw, int $length, string $keys): void 61{
62 for ($off = 0; $off < $length;) {
63 $packetLength = unpack("S", $encryptedFileRaw, $off)[1];Doc comment missing for function
encrypt 27 return true;
28}
29
30function encrypt(string &$decryptedFileRaw, int $length, string $keys): void 31{
32 for ($off = 0; $off < $length;) {
33 $packetLength = unpack("S", $decryptedFileRaw, $off)[1];Doc comment missing for function
readDataFile 14 return true;
15}
16
17function readDataFile(string $path, string &$buffer, int &$fileSize): bool 18{
19 $handle = fopen($path, "rb");
20 if ($handle === false) {Doc comment missing for function
readKeys 2
3$keys = "";
4
5function readKeys(string $path, string &$keys): bool 6{
7 $handle = fopen($path, "rb");
8 if ($handle === false) {
Description
Documentation comments are helpful in understanding what that part of the code is responsible for. It is always a good idea to add documentation to your code to improve the code readability and maintainability. In addition to that, it becomes helpful when you revisit the code after a long time. Here, the function/class method is missing the doc comment and it is recommended to add it for the reasons discussed above.