Лучший способ автоматически удалять комментарии из кода PHP - PullRequest
45 голосов
/ 02 февраля 2009

Какой лучший способ удалить комментарии из файла PHP?

Я хочу сделать что-то похожее на strip-whitespace () - но оно также не должно удалять разрывы строк.

EG:

Я хочу это:

<?PHP
// something
if ($whatsit) {
    do_something(); # we do something here
    echo '<html>Some embedded HTML</html>';
}
/* another long 
comment
*/
some_more_code();
?>

стать:

<?PHP
if ($whatsit) {
    do_something();
    echo '<html>Some embedded HTML</html>';
}
some_more_code();
?>

(Хотя, если в комментариях нет пустых строк, это не будет нормально).

Это может быть невозможным из-за необходимости сохранения встроенного html - вот что запутало вещи, которые появились в Google.

Ответы [ 12 ]

51 голосов
/ 02 февраля 2009

Я бы использовал токенизатор . Вот мое решение. Должно работать как на PHP 4, так и на 5:

$fileStr = file_get_contents('path/to/file');
$newStr  = '';

$commentTokens = array(T_COMMENT);

if (defined('T_DOC_COMMENT'))
    $commentTokens[] = T_DOC_COMMENT; // PHP 5
if (defined('T_ML_COMMENT'))
    $commentTokens[] = T_ML_COMMENT;  // PHP 4

$tokens = token_get_all($fileStr);

foreach ($tokens as $token) {    
    if (is_array($token)) {
        if (in_array($token[0], $commentTokens))
            continue;

        $token = $token[1];
    }

    $newStr .= $token;
}

echo $newStr;
39 голосов
/ 02 февраля 2009

Как насчет использования php -w для генерации файла без комментариев и пробелов, а затем с помощью beautifier вроде PHP_Beautifier для переформатирования для удобства чтения?

8 голосов
/ 15 ноября 2011

Вот функция, опубликованная выше, модифицированная для рекурсивного удаления всех комментариев из всех файлов php внутри каталога и всех его подкаталогов:

function rmcomments($id) {
    if (file_exists($id)) {
        if (is_dir($id)) {
            $handle = opendir($id);
            while($file = readdir($handle)) {
                if (($file != ".") && ($file != "..")) {
                    rmcomments($id."/".$file); }}
            closedir($handle); }
        else if ((is_file($id)) && (end(explode('.', $id)) == "php")) {
            if (!is_writable($id)) { chmod($id,0777); }
            if (is_writable($id)) {
                $fileStr = file_get_contents($id);
                $newStr  = '';
                $commentTokens = array(T_COMMENT);
                if (defined('T_DOC_COMMENT')) { $commentTokens[] = T_DOC_COMMENT; }
                if (defined('T_ML_COMMENT')) { $commentTokens[] = T_ML_COMMENT; }
                $tokens = token_get_all($fileStr);
                foreach ($tokens as $token) {    
                    if (is_array($token)) {
                        if (in_array($token[0], $commentTokens)) { continue; }
                        $token = $token[1]; }
                    $newStr .= $token; }
                if (!file_put_contents($id,$newStr)) {
                    $open = fopen($id,"w");
                    fwrite($open,$newStr);
                    fclose($open); }}}}}

rmcomments("path/to/directory");
7 голосов
/ 02 февраля 2009
$fileStr = file_get_contents('file.php');
foreach (token_get_all($fileStr) as $token ) {
    if ($token[0] != T_COMMENT) {
        continue;
    }
    $fileStr = str_replace($token[1], '', $fileStr);
}

echo $fileStr;

редактировать Я понял, что Ионут Дж. Стэн уже предложил это, но я оставлю пример здесь

3 голосов
/ 03 января 2016

более мощная версия: удалить все комментарии в папке

<?php
$di = new RecursiveDirectoryIterator(__DIR__,RecursiveDirectoryIterator::SKIP_DOTS);
$it = new RecursiveIteratorIterator($di);
$fileArr = [];
foreach($it as $file){
    if(pathinfo($file,PATHINFO_EXTENSION) == "php"){
        ob_start();
        echo $file;
        $file = ob_get_clean();
        $fileArr[] = $file;
    }
}
$arr = [T_COMMENT,T_DOC_COMMENT];
$count = count($fileArr);
for($i=1;$i < $count;$i++){
    $fileStr = file_get_contents($fileArr[$i]);
    foreach(token_get_all($fileStr) as $token){
        if(in_array($token[0],$arr)){
            $fileStr = str_replace($token[1],'',$fileStr);
        }            
    }
    file_put_contents($fileArr[$i],$fileStr);
}
2 голосов
/ 25 февраля 2014

Если вы уже используете редактор, такой как UltraEdit , вы можете открыть один или несколько файлов PHP и затем использовать простой Find & Replace (CTRL + R) со следующим Perl регулярное выражение

(?s)/\*.*\*/

Обратите внимание, что приведенное выше регулярное выражение удаляет также комментарии внутри sring, т. Е. В echo "hello/*babe*/"; также будет удален /*babe*/. Следовательно, это может быть решением, если у вас мало файлов для удаления комментариев, чтобы быть абсолютно уверенным, что оно не заменит неправильно то, что не является комментарием, вам нужно будет запустить команду «Найти и заменить» и утверждать каждый раз, что заменяется.

1 голос
/ 18 января 2017

Запустите команду php --strip file.php в командной строке (т.е. cmd.exe ), затем перейдите к http://www.writephponline.com/phpbeautifier.

Здесь file.php - ваш собственный файл.

1

1 голос
/ 13 августа 2016

Решение Bash: если вы хотите рекурсивно удалять комментарии из всех PHP-файлов, начиная с текущего каталога, вы можете написать в терминале эту однострочную строку. (он использует файл temp1 для хранения содержимого PHP для обработки) Обратите внимание, что это уберет все пробелы с комментариями.

 find . -type f -name '*.php' | while read VAR; do php -wq $VAR > temp1  ;  cat temp1 > $VAR; done

Затем вы должны удалить temp1 файл после.

если PHP_BEAUTIFER установлен , то вы можете получить красиво отформатированный код без комментариев с помощью

 find . -type f -name '*.php' | while read VAR; do php -wq $VAR > temp1; php_beautifier temp1 > temp2;  cat temp2 > $VAR; done;

затем удалите два файла (temp1, temp2)

1 голос
/ 18 июня 2013

Для ответов ajax / json я использую следующий код PHP, чтобы удалять комментарии из кода HTML / JavaScript, поэтому он будет меньше (примерно 15% прироста для моего кода).

// Replace doubled spaces with single ones (ignored in HTML any way)
$html = preg_replace('@(\s){2,}@', '\1', $html);
// Remove single and multiline comments, tabs and newline chars
$html = preg_replace(
    '@(/\*([^*]|[\r\n]|(\*+([^*/]|[\r\n])))*\*+/)|((?<!:)//.*)|[\t\r\n]@i',
    '',
    $html
);

Коротко и эффективно, но может привести к неожиданным результатам, если ваш код имеет синтаксис $ itty.

1 голос
/ 08 апреля 2013
/*
* T_ML_COMMENT does not exist in PHP 5.
* The following three lines define it in order to
* preserve backwards compatibility.
*
* The next two lines define the PHP 5 only T_DOC_COMMENT,
* which we will mask as T_ML_COMMENT for PHP 4.
*/

if (! defined('T_ML_COMMENT')) {
    define('T_ML_COMMENT', T_COMMENT);
} else {
    define('T_DOC_COMMENT', T_ML_COMMENT);
}

/*
 * Remove all comment in $file
 */

function remove_comment($file) {
    $comment_token = array(T_COMMENT, T_ML_COMMENT, T_DOC_COMMENT);

    $input = file_get_contents($file);
    $tokens = token_get_all($input);
    $output = '';

    foreach ($tokens as $token) {
        if (is_string($token)) {
            $output .= $token;
        } else {
            list($id, $text) = $token;

            if (in_array($id, $comment_token)) {
                $output .= $text;
            }
        }
    }

    file_put_contents($file, $output);
}

/*
 * Glob recursive
 * @return ['dir/filename', ...]
 */

function glob_recursive($pattern, $flags = 0) {
    $file_list = glob($pattern, $flags);

    $sub_dir = glob(dirname($pattern) . '/*', GLOB_ONLYDIR);
    // If sub directory exist
    if (count($sub_dir) > 0) {
        $file_list = array_merge(
            glob_recursive(dirname($pattern) . '/*/' . basename($pattern), $flags),
            $file_list
        );
    }

    return $file_list;
}

// Remove all comment of '*.php', include sub directory
foreach (glob_recursive('*.php') as $file) {
    remove_comment($file);
}
...