如何在 PHP 中添加注释

作者: Sara Rhodes
创建日期: 16 二月 2021
更新日期: 1 七月 2024
Anonim
零基础Java教程08期 基础语法之注释 程序员入门宝典
视频: 零基础Java教程08期 基础语法之注释 程序员入门宝典

内容

注释是一种注释,可用于解释代码片段的目的和含义。在 PHP 中工作时,您将有多种选择来编写来自旧的著名编程语言的注释:通过输入单行或多行 C 注释。您可以使用注释来阻止一段代码工作,或者只是为了保持记录。

脚步

第 1 部分(共 2 部分):样式

  1. 1 短帖子的单行评论。 如果您需要留下简短的评论,请使用单行评论代码。注释只会延伸到一行的末尾或代码块的末尾。此类注释仅在 PHP 标签中有效,并且只有在放置在 HTML 中时才会被读取。

    ? php // 这是创建单行注释的标准(C++)方式 # 你也可以使用这种Unix风格来创建单行注释?> var13 ->

  2. 2 使用多行注释编写长注释或测试代码。 多行注释对于编写长解释和防止处理一段代码非常有用。有关使用多行注释的一些提示,请阅读用法部分。

    ? php / * 这里是如何格式化多行注释。直到标签结束的所有文本都将包含在注释中 * / / * 有些人喜欢在每行的开头包含 * * 额外的项目符号。这将提高 * 大注释的可读性,尽管这不是必需的。 * /?> var13 ->

第 2 部分(共 2 部分):使用

  1. 1 使用注释留下关于代码健康的注释。 您不必对每一行代码都这样做,因为其他程序员可以轻松找出编写良好的代码。当您的代码执行非标准或不明显的功能时,注释很有用。

    // 创建一个 curl 请求 $session = curl_init($request); // 告诉 curl 使用 HTTP POST curl_setopt ($ session, CURLOPT_POST, true);

  2. 2 留下评论,这样你就不会忘记你对代码做了什么。 在处理项目时,评论将使您不会忘记上次中断的地方。为工作不正常或您尚未完成的代码留下评论。

    // 在进入下一步之前,仔细检查这个程序的输出 echo "Hello World!";

  3. 3 为您计划共享的代码留下评论。 如果您打算与其他程序员合作或打算公开您的代码,评论将帮助其他人了解您的代码如何工作以及需要修复哪些内容。

    / * 有没有更好的方法来实现这个? * / Gender: input type = "radio" name = "gender"? Php if (isset ($性别) && $性别== "女性") echo "checked" ; ?> value = "female"> 女性输入类型 = "radio" name = "gender"? php if (isset ($性别) && $性别 == "男性") echo "checked";?> value = "male" “ > 男

  4. 4 留下注释以撤消特定的代码块。 当您测试代码并希望阻止其中的一部分运行时,这非常有用。页面启动时,注释标记中包含的任何内容都将被忽略。

    ? php echo "/*你好*/世界!"; / * 上面代码运行时,不会反映“Hello”这个词 * /?> Var13 ->

  5. 5 注释掉大块代码时要小心。 注释功能将在第一个完成标记处于活动状态时结束,因此如果您已经注释的代码中存在多行注释,它只会持续到原始注释的开头。

    ? php / * echo "Hello World!"; / * 这个评论会毁了一切 * / * /?> Var13 ->

    ? php / * echo "Hello World!"; // 这个注释就可以了 * /?> Var13 ->

  6. 6 使用评论创建伪录音。 您可以使用一些创造性的代码格式在其中创建代码条目。这对于开源项目非常有用。

    ? php // ============ // 标题 // ============== // ------------ - // 副标题 // ------------- / * 部分名称 * / # 条目可以写在这里 # 第二部分可以写在这里 / * * 用这个来解释 * 为什么你需要几行 * 甚至几点解释 * /?> var13 ->

提示

  • HTML 和 PHP 注释彼此不同,因此在使用脚本(HTML 和 PHP 的组合)时,请确保使用正确的语法。
  • 例如,下面的代码包含一个 HTML 注释,但它仍然执行 PHP 代码。如果将 HTML 注释放在 PHP 标记中,则会导致错误。
    • !-div id = "example">?php echo 'hello'; ?> var13 -> / div> ->