From 73762bb72bbbade0436cbff47f5ea75cc0085eee Mon Sep 17 00:00:00 2001 From: "Stephen A. Bernhardt" Date: Sun, 1 Jun 2025 00:09:21 -0500 Subject: [PATCH] Use variable names of different lengths in DocBlock example If one global variable's name is longer than the other in the group, that can help demonstrate how they are "aligned by type, variable, and description." - My suggestions for the names could be better. - The `param` examples might benefit from a similar revision. --- inline-documentation-standards/php.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/inline-documentation-standards/php.md b/inline-documentation-standards/php.md index eb58414..294767f 100644 --- a/inline-documentation-standards/php.md +++ b/inline-documentation-standards/php.md @@ -206,8 +206,8 @@ Functions and class methods should be formatted as follows: * * @see Function/method/class relied on * @link URL - * @global type $varname Description. - * @global type $varname Description. + * @global type $variable_name Description. + * @global type $another_variable Description. * * @param type $var Description. * @param type $var Optional. Description. Default.