Komen sangat penting dalam proses menulis kod yang baik boleh memudahkan kod anda dibaca Semasa menulis kod, anda mesti memberi perhatian kepada spesifikasi komen Di sini, editor Script House akan menyelesaikannya anda. Rakan yang memerlukan boleh merujuknya.
Spesifikasi Komen HP
Komen sangat penting dalam proses menulis kod kod, pastikan anda memberi perhatian kepada spesifikasi ulasan.
“PHP ialah bahasa yang sangat mudah untuk dimulakan. Seorang pemula yang baru bermula mungkin boleh menggunakan gema untuk mencetak dunia helo dalam masa kurang daripada beberapa minit? Bagaimana untuk melakukannya? Bagaimana dengan mentakrifkan seorang pengaturcara? Jika anda ingin benar-benar menjadi seorang pengaturcara, anda mesti mengikut satu set piawaian penulisan program "
Kami sering menulis beberapa fungsi, tetapi fungsi ini hanya boleh difahami. oleh diri kita sendiri, malah Sudah agak lama saya tidak mengenali apa yang saya tulis, jadi apakah yang perlu saya lakukan? Cara terbaik sudah tentu dengan menambah komen pada kod anda.
Kami mungkin biasa dengan banyak cara menulis ulasan, ulasan C pear PHP, dll., tetapi yang utama yang kami gunakan ialah # dan /**/.
# ialah kaedah ulasan ringkas. Mungkin anda akan menggunakannya untuk menganotasi pembolehubah atau memanggil kaedah. /**/ keluar sebahagian besar kod , tetapi bagaimana untuk menggunakannya untuk menganotasi fungsi secara standard?
/** * @name 名字 * @abstract 申明变量/类/方法 * @access 指明这个变量、类、函数/方法的存取权限 * @author 函数作者的名字和邮箱地址 * @category 组织packages * @copyright 指明版权信息 * @const 指明常量 * @deprecate 指明不推荐或者是废弃的信息 * @example 示例 * @exclude 指明当前的注释将不进行分析,不出现在文挡中 * @final 指明这是一个最终的类、方法、属性,禁止派生、修改。 * @global 指明在此函数中引用的全局变量 * @include 指明包含的文件的信息 * @link 定义在线连接 * @module 定义归属的模块信息 * @modulegroup 定义归属的模块组 * @package 定义归属的包的信息 * @param 定义函数或者方法的参数信息 * @return 定义函数或者方法的返回信息 * @see 定义需要参考的函数、变量,并加入相应的超级连接。 * @since 指明该api函数或者方法是从哪个版本开始引入的 * @static 指明变量、类、函数是静态的。 * @throws 指明此函数可能抛出的错误异常,极其发生的情况 * @todo 指明应该改进或没有实现的地方 * @var 定义说明变量/属性。 * @version 定义版本信息 */
Maklumat dalam anotasi adalah sangat komprehensif. Mungkin terdapat banyak bahagian yang tidak kami gunakan.
Contoh: Beberapa kaedah ulasan biasa dalam php:
1 Ulasan pada fail, memperkenalkan nama fail, fungsi, nombor versi pengarang dan maklumat lain
/** * 文件名简单介绍 * * 文件功能 * @author 作者 * @version 版本号 * @date 2020-02-02 */
Templat Pengepala Fail
/** *这是一个什么文件 * *此文件程序用来做什么的(详细说明,可选。)。 * @author richard<e421083458@163.com> * @version $Id$ * @since 1.0 */
2. Komen kelas, nama kelas dan pengenalan
/** * 类的介绍 * * 类的详细介绍(可选) * @author 作者 * @version 版本号 * @date 2020-02-02 */
/** * 类的介绍 * * 类的详细介绍(可选。)。 * @author richard<e421083458@163.com> * @since 1.0 */ class Test { }
3 Ulasan fungsi, fungsi fungsi, pengenalan parameter dan jenis pulangan
/** * 函数的含义说明 * * @access public * @author 作者 * @param mixed $arg1 参数一的说明 * @param mixed $arg2 参数二的说明 * @return array 返回类型 * @date 2020-02-02 */
Komen pengepala fungsi
/** * some_func * 函数的含义说明 * * @access public * @param mixed $arg1 参数一的说明 * @param mixed $arg2 参数二的说明 * @param mixed $mixed 这是一个混合类型 * @since 1.0 * @return array */ public function thisIsFunction($string, $integer, $mixed) {return array();}
Komen kod program
1 jelas bahawa lebih banyak tidak selalu lebih baik.
2. Beberapa pernyataan digunakan sebagai blok kod logik, dan komen blok ini boleh menjadi /* */.
3 Untuk ulasan khusus untuk pernyataan tertentu, anda boleh menggunakan ulasan akhir baris: //.
/* 生成配置文件、数据文件。*/ $this->setConfig(); $this->createConfigFile(); //创建配置文件 $this->clearCache(); // 清除缓存文件 $this->createDataFiles(); // 生成数据文件 $this->prepareProxys(); $this->restart();
Konvensyen penamaan PHP
1. Direktori dan fail
Gunakan huruf kecil untuk direktori + Underscore
Perpustakaan kelas dan fail fungsi semuanya diakhiri dengan .php
Nama fail kelas semuanya ditakrifkan dalam ruang nama dan laluan ruang nama adalah konsisten dengan laluan fail perpustakaan kelas
Fail kelas dinamakan menggunakan huruf besar unta (Huruf pertama huruf besar), fail lain dinamakan dalam huruf kecil + garis bawah
Nama kelas dan nama fail kelas adalah konsisten, dan kaedah kes unta digunakan secara seragam (huruf pertama ditulis dengan huruf besar)
2. Fungsi dan kelas, penamaan atribut
Kelas dinamakan menggunakan huruf besar (huruf pertama huruf besar), seperti User, UserType Secara lalai, tiada akhiran adalah diperlukan. Contohnya, UserController hendaklah dinamakan terus Pengguna
Fungsi dinamakan menggunakan huruf kecil dan garis bawah (bermula dengan huruf kecil) Contohnya, nama kaedah get_client_ip
menggunakan kes unta (huruf pertama ialah huruf kecil), seperti getUserName (jika kaedah mempunyai nilai pulangan, pada masa ini adalah kebiasaan untuk menggunakan huruf pertama dalam huruf kecil untuk jenis atribut, seperti s(string), i(int ), f (float), b ( boolean), a (array), dsb.)
Penamaan atribut menggunakan huruf besar unta (huruf pertama adalah huruf kecil), seperti tableName, contoh (adalah kebiasaan untuk menggunakan huruf kecil untuk huruf pertama jenis atribut, Seperti s (rentetan), i (int), f (float), b (boolean), a (array), dll.)
Fungsi atau kaedah bermula dengan garis bawah berganda "__" digunakan sebagai kaedah ajaib, seperti sebagai __call dan _ _autoload
3 Pemalar dan konfigurasi
Pemalar dinamakan dengan huruf besar dan garis bawah, seperti APP_PATH dan THINK_PATH
Parameter konfigurasi dinamakan dengan huruf kecil dan garis bawah, seperti sebagai url_route_on dan url_convert
4 medan kotak jadual data
Jadual dan medan data dinamakan dalam huruf kecil dan bergaris bawah, dan berhati-hati untuk tidak memulakan nama medan dengan garis bawah, seperti jadual think_user dan medan nama_pengguna tidak disyorkan untuk menggunakan kotak unta dan bahasa Cina untuk penamaan medan.

PHP注释大揭秘:单行注释和多行注释详细对比PHP是一种广泛应用的网页开发语言,其中注释的使用对于代码的可读性和维护性起着至关重要的作用。在PHP中,常见的注释有单行注释和多行注释两种形式。本文将详细对比这两种注释形式,并提供具体的代码示例,帮助读者更好地理解它们的用法和差异。一、单行注释单行注释是在代码中添加一行注释,以//开头,直到行尾为止。单行注释

php注释的种类有单行注释、多行注释、文档注释和条件注释等。详细介绍:1、单行注释以双斜杠“//”开头,用于注释单行代码,在这种注释类型中,从双斜杠开始到该行末尾的所有内容都将被视为注释,不会被解释为代码;2、多行注释以斜杠星号“/”开头,以星号斜杠“*/”结尾,这种注释类型可用于注释一段代码或多行代码;3、文档注释也以斜杠星号“/”开头,以星号斜杠“*/”结尾等等。

代码注释是程序员在编写代码时添加的文本提醒,以便自己和其他程序员更轻松地阅读和理解代码。在PHP中,代码注释是不可或缺的。本文将详细介绍PHP中的代码注释的类型、规范和用途。一、PHP中的代码注释类型在PHP中,有三种类型的注释:单行注释、多行注释和文档注释。单行注释单行注释以双斜线“//”开始,直到行尾结束。例如://这是一个单行注释多行注释多行注释以“

PHP是一种流行的服务器端脚本语言,广泛应用于Web开发领域。在代码编写过程中,注释是一个非常重要的元素,可以帮助开发者更好地理解代码,提高代码的可读性和可维护性。本文将详细介绍PHP中的注释类型,包括单行注释与多行注释,同时提供具体的代码示例。单行注释在PHP中,使用双斜杠//可以实现单行注释。单行注释从//开始一直到该行的末尾。单行注释通常用于对代码进行

php的注释种类有:1、单行注释,用于解释某个功能、提醒其他开发者或自己注意点等;2、多行注释,用于对多行代码块进行详细的说明;3、文档注释,用于对整个代码块或函数、方法进行详细的说明。

进入PHP编程领域,注释是一个非常重要的概念。在编写代码时,注释对于阐述代码意图、帮助其他开发者理解代码逻辑以及方便自己日后维护代码都是至关重要的。在PHP中,注释分为单行注释和多行注释两种,在使用上有一些区别。本文将深入探讨PHP注释的特点以及单行注释和多行注释的使用方式,并通过具体的代码示例进行说明。1.单行注释单行注释是在代码中添加一行注释,用来解释

如何在PHP中使用注释来增强代码可读性和理解性引言:在开发过程中,注释是一个非常重要的组成部分,可以帮助开发者更好地理解代码,提高代码的可读性和维护性。本文将介绍在PHP中如何使用注释来增强代码的可读性和理解性,并提供一些实际的代码示例。单行注释单行注释是用来对代码的某一行进行解释和说明。在PHP中,单行注释以双斜杠(//)开头,直到行尾结束。下面是一个示例

PHP注释规范:如何使用文档注释编写API文档引言:在开发PHP应用程序时,编写完善的API文档对于开发团队和其他开发者来说非常重要。好的文档可以提高代码的可读性和可维护性,并促进团队合作与信息共享。本文将介绍如何使用文档注释编写PHP的API文档,并提供一些示例代码帮助读者理解如何规范地编写注释。注释规范在PHP中,我们使用注释来对代码进行说明和描述。一般


Alat AI Hot

Undresser.AI Undress
Apl berkuasa AI untuk mencipta foto bogel yang realistik

AI Clothes Remover
Alat AI dalam talian untuk mengeluarkan pakaian daripada foto.

Undress AI Tool
Gambar buka pakaian secara percuma

Clothoff.io
Penyingkiran pakaian AI

AI Hentai Generator
Menjana ai hentai secara percuma.

Artikel Panas

Alat panas

SublimeText3 versi Mac
Perisian penyuntingan kod peringkat Tuhan (SublimeText3)

MinGW - GNU Minimalis untuk Windows
Projek ini dalam proses untuk dipindahkan ke osdn.net/projects/mingw, anda boleh terus mengikuti kami di sana. MinGW: Port Windows asli bagi GNU Compiler Collection (GCC), perpustakaan import yang boleh diedarkan secara bebas dan fail pengepala untuk membina aplikasi Windows asli termasuk sambungan kepada masa jalan MSVC untuk menyokong fungsi C99. Semua perisian MinGW boleh dijalankan pada platform Windows 64-bit.

Muat turun versi mac editor Atom
Editor sumber terbuka yang paling popular

Dreamweaver CS6
Alat pembangunan web visual

VSCode Windows 64-bit Muat Turun
Editor IDE percuma dan berkuasa yang dilancarkan oleh Microsoft