如何使这段代码更具可读性

Question

这是php代码的一部分，它使用contentArray，它是一个JSON，并向用户生成UI，它生成html标签，也生成js代码......它有效，但我认为代码很难阅读和维护，有什么想法吗？？？谢谢。

for($i = 0; $i < count($contentArray); $i++){  

    if($i %2 == 0){
       echo ("<li class='even_row'>");
    }else{
       echo ("<li class='odd_row'>");
    }  
    $content = $contentArray[$i];    

    echo("<textarea class='userdata' id='user_data_textarea_".$content->{'m_sId'}."'>");
    echo($content->{'m_sDataContent'});  
    echo("</textarea>"); 

echo("</li>");   

    echo("<script type='text/javascript'>");

    echo("$('#user_data_textarea_".$content->{'m_sId'}."').bind('keydown', function(e){");  
    echo("  TypingHandler.handleTypingInUserDataTextArea(".$content->{'m_sId'}.", e);");
    echo(" });");    

    echo("</script>");

}            

Answer 1

首先，对于奇数和偶数样式，不需要类只需使用 css

这里是信息 然后在

php 中只在一行中回显您需要的内容

$count = count($contentArray);
for($i = 0; $i < $count; $i++){  
    $content = $contentArray[$i];    
    echo('<li><textarea class="userdata" id="user_data_textarea_"'.$content->{'m_sId'}.'">'.$content->{'m_sDataContent'}.'</textarea></li>');   
}

，然后将 jquery 放在远离 php 的 html 页面中，

我们可以通过使用 以选择器开头

$('[id^=user_data_textarea_]').bind('keydown', function(e){  
    var id = this.id.str_replace("user_data_textarea","");
    TypingHandler.handleTypingInUserDataTextArea(id, e);
});    

Answer 2

关于“for”循环的一个技巧是，您应该在循环之前计算 $contentArray 的计数。每次执行循环时，都必须调用该函数。

$count = count($contentArray);

for ($i=0; $i<count; $i++) {
// ...
}

Answer 3

你可以尝试真正的 HTML：

<?php
for($i = 0; $i < count($contentArray); $i++){  
  $rowClass = $i %2 == 0 ?'even_row' : 'odd_row';
?>
    <li class='<?= $rowClass ?>'>
      <textarea class='userdata' id='user_data_textarea_<?=$content->{'m_sId'}?>'>
        <?= $content->{'m_sDataContent'} ?>
      </textarea>
    </li>
    <script type='text/javascript'>
    //etc...
    </script>
<?php } ?>

Answer 4

它应该看起来像这样，以便在 IDE 中具有更好的可读性。

<?php
foreach($contentArray as $content){
    ?>
    <li>
        <textarea class="userdata" id="user_data_textarea<?php echo htmlentities($content['m_sId']); ?>">
            <?php echo htmlspecialchars($content['m_sDataContent']); ?>
        </textarea>
        <script type="text/javascript">
            $('#user_data_textarea_<?php echo htmlspecialchars($content['m_sId']); ?>').bind('keydown',function(e){
                TypingHandler.handleTypingInUserDataTextArea('<?php echo htmlspecialchars($content['m_sId']); ?>',e);
            });
        </script>
    </li>
<?php
}

Answer 5

您可以从 echo 语句中删除 ( )，它们不一定需要，并且可能有助于使其看起来更整洁......

Answer 6

这对我来说实际上看起来很容易理解；我可以毫无困难地弄清楚你在做什么。我建议的唯一区别是使用 三元运算符对于行类：

echo "<li class='".( ($i%2 == 0) ? "even" : "odd" )."_row'>";

...但这只是我的情况，有些人会发现这更令人困惑，而不是更少。我个人喜欢将所有内容放在一行中。

Answer 7

就我个人而言，我喜欢使用 printf 在 php 中编写 html 代码。它可能看起来像：

for($i = 0; $i < count($contentArray); $i++){  

    printf("<li class='%s'>", $i % 2 ? "odd_row" : "even_row"); 
    $content = $contentArray[$i];    

    printf("<textarea class='userdata' id='user_data_textarea_%s'>%s</textarea>",
        $content->{'m_sId'},
        $content->{'m_sDataContent'});

    echo("</li>");   

    echo("<script type='text/javascript'>");

    printf("$('#user_data_textarea_%1$s').bind('keydown', function(e){
        TypingHandler.handleTypingInUserDataTextArea(%1$s, e);
         });",
        $content->{'m_sId'});     

    echo("</script>");

}    

Answer 8

<?php
    foreach($contentArray as $content){
        $class = ($i %2 == 0) ? "even_row": "odd_row"; ?>
        <li class="<?php echo $class ?>">
            <textarea class='userdata' id='user_data_textarea_<? echo $content['m_sId'] ?>'>
                <? php echo $content['m_sDataContent'] ?>
            </textarea>
        </li>
        <script type='text/javascript'>
            $('#user_data_textarea_<?php echo content['m_sId'] ?>').bind('keydown', function(e){
                TypingHandler.handleTypingInUserDataTextArea(<?php $content['m_sId'] ?>, e);
            });
        </script>
<?php } // end foreach ?>

Answer 9

jQuery 代码应该已经在 HTML 中，使用一些主选择器而不是一一绑定元素，这对我来说没有意义。这应该可以澄清你的代码。

for($i = 0; $i < count($contentArray); $i++){  
    $content = $contentArray[$i];    

    echo "<li class='" . (($i %2 == 0) ? "even_row" : "odd_row") . ">";
        echo "<textarea class='userdata' id='user_data_textarea_".$content->{'m_sId'}."'>";
        echo $content->{'m_sDataContent'};  
        echo "</textarea>"; 
    echo "</li>";   
}      

添加

一般情况：

$(function() {
    $('.userdata').click(function() {
        some_function($(this).attr('id');
    });
})

即使用类选择器进行绑定，并稍后使用一些唯一标识符来完成这项工作。

Answer 10

将所有内容放入数组中，然后在循环末尾回显它们。

// Put each item in the array, then echo at the end
$items = array();
$js = array();

// I'm assuming that your content array has numeric keys
// if not, use the for statement from your original code
foreach ($contentArray as $i => $content) 
{
    // using sprintf
    $items[] = sprintf('<li class="%s_row"><textarea class="userdata" id="user_data_textarea_%s">%s</textarea></li>'
        , ($i % 2) ? 'even' : 'odd'
        , $content->m_sId
        , $content->m_sDataContent
    );

    // or just plain old concatenation
    $js[] = "$('#user_data_textarea_{$content->m_sId}').bind('keydown', function(e){TypingHandler.handleTypingInUserDataTextArea({$content->m_sId}, e);});";
}

echo "<ul>" . join("\n", $items) . "</ul>\n"
    . '<script type="text/javascript">' . join("\n", $js) . "</script>\n";

Answer 11

使用例如 smarty 分隔您的内容和代码。它在短期内需要一些基础设施投资，但从长远来看可以改善维护。

考虑到这些评论，让我们将 PHP 视为真正的模板语言。

$contentCount = count($contentArray);
for($i = 0; $i < $contentCount; $i++)
{
    $rowType = ( $i % 2 ) ? 'even' : 'odd';
    $content = $contentArray[$i];
    echo <<<EOT
<li class='{$rowType}_row'>
    <textarea class='userdata' id='user_data_textarea_{$content->m_sId}'>
        {$content->m_sDataContent}
    </textarea>

</li>
<script type="text/javascript">
    $('#user_data_textarea_{$content->m_sId}').bind('keydown', function(e)
    {
        TypingHandler.handleTypingInUserDataTextArea({$content->m_sId}, e);
    }
</script>
EOT;
}