Frage zur Einleitung von Kommentaren
Verfasst: 07.03.2014 21:14
Hallo,
beim Schreiben einer MOD für phpBB3 ist mir aufgefallen, daß innerhalb der phpBB3-Programmdateien
(wie z.B. includes/functions.php) Kommentare für Funktionen immer mit /** eingeleitet werden.
Hier mal ein Auszug aus der functions.php:
Ich frage mich nun Folgendes:
Hat es einen speziellen Grund, an die Kommentareinleitung mit /* ein weiteres * anzuhängen?
Dies bedeutet, daß bei jedem mehrzeiligen phpBB-Kommentar eine leere Zeile (die lediglich ein * am Anfang der Zeile enthält) dem eigentlichen Kommentar-Text vorangestellt wird. Wozu soll das gut sein? Ist das eventuell für die bessere Lesbarkeit des Quelltextes beim Programmieren hilfreich?
Ich frage mich speziell, ob ich auch für meine MOD diese Kommentarauszeichnung so übernehmen sollte oder nicht.
Für eine Erklärung wäre ich sehr dankbar.
Gruß,
Arni
beim Schreiben einer MOD für phpBB3 ist mir aufgefallen, daß innerhalb der phpBB3-Programmdateien
(wie z.B. includes/functions.php) Kommentare für Funktionen immer mit /** eingeleitet werden.
Hier mal ein Auszug aus der functions.php:
Code: Alles auswählen
<?php
/**
*
* @package phpBB3
* @version $Id$
* @copyright (c) 2005 phpBB Group
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
*
*/
/**
* @ignore
*/
if (!defined('IN_PHPBB'))
{
exit;
}
// Common global functions
/**
* set_var
*
* Set variable, used by {@link request_var the request_var function}
*
* @access private
*/
function set_var(&$result, $var, $type, $multibyte = false)
{
Hat es einen speziellen Grund, an die Kommentareinleitung mit /* ein weiteres * anzuhängen?
Dies bedeutet, daß bei jedem mehrzeiligen phpBB-Kommentar eine leere Zeile (die lediglich ein * am Anfang der Zeile enthält) dem eigentlichen Kommentar-Text vorangestellt wird. Wozu soll das gut sein? Ist das eventuell für die bessere Lesbarkeit des Quelltextes beim Programmieren hilfreich?
Ich frage mich speziell, ob ich auch für meine MOD diese Kommentarauszeichnung so übernehmen sollte oder nicht.
Für eine Erklärung wäre ich sehr dankbar.
Gruß,
Arni
