PHP-D1002 · Missing function/class method doc comment

guibranco / gstraccini-bot

Active

Missing function/class method doc comment PHP-D1002

Documentation

Minor

2 days ago — 7 months old

Doc comment missing for function execute_cargoClippy

281    callWorkflow($config, $metadata, $comment, "bump-version.yml");
282}
283
284function execute_cargoClippy($config, $metadata, $comment)285{
286    doRequestGitHub($metadata["token"], $metadata["reactionUrl"], array("content" => "eyes"), "POST");
287    $body = "Running [Cargo Clippy](https://doc.rust-lang.org/clippy/usage.html) on this branch! :wrench:";

Doc comment missing for function handleItem

Src/comments.php

  5use GuiBranco\Pancake\GUIDv4;
  6use GuiBranco\Pancake\HealthChecks;
  7
  8function handleItem($comment)  9{
 10    $config = loadConfig();
 11

Doc comment missing for function execute_copyIssue

Src/comments.php

289    callWorkflow($config, $metadata, $comment, "cargo-clippy.yml");
290}
291
292function execute_copyIssue($config, $metadata, $comment)293{
294    preg_match(
295        "/@" . $config->botName . "\scopy\sissue\s([a-zA-Z0-9_.-]+)\/([a-zA-Z0-9_.-]+)/",

Doc comment missing for function execute_addProject

Src/comments.php

128    doRequestGitHub($metadata["token"], $metadata["commentUrl"], array("body" => $helpComment), "POST");
129}
130
131function execute_addProject($config, $metadata, $comment)132{
133    preg_match(
134        "/@" . $config->botName."\sadd\sproject\s(.+?\.csproj)/",

Doc comment missing for function main

Src/comments.php

575}
576
577
578function main()579{
580    $config = loadConfig();
581    ob_start();

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.