Home Backend Development PHP Tutorial PHP程序写大量注释好吗?该如何解决

PHP程序写大量注释好吗?该如何解决

Jun 13, 2016 pm 12:10 PM
gt nbsp record today

PHP程序写大量注释好吗?
我写php代码有大量注释,会不会有什么对php运行性能有不好的影响啊?
注释多的很,有时间比代码本身还多。有没有什么弊端?


如:

//这个是投票的核心功能区,只要该用户今天没有投票就可以投票<br />//投票成功:1.本投票表对应行记录增加一票 2.投票记录表增加该用户的投票记录,防止他今天再投。<br /><br />$voteid=$_GET["voteid"];<br /><br />//拿到id了,但是我们不是直接就给这个id添加一票。我们要先看看,这个ip今天是否已经投过票了。<br /><br />//有了ip黑名单功能,我们应该在最先核实该用户是否已经进入我们的黑名单了,如果进了黑名单,后面的所有都不用走了。<br /><br /><br /><br /><br /><br />//我们先拿到这个朋友的ip。<br />$nowip=$_SERVER["REMOTE_ADDR"];<br />$today=date("Ymd");<br /><br /><br />//然后去我们ip记录表查询今天这个ip是否有记录<br />$where="ip='$nowip' and votedate='$today'";<br /><br />//下面我们查询记录表,看看有没有相关记录<br />$record=new Record();<br />$res=$record->fetchAll($where)->toArray();<br />if(count($res) > 10){<br />$this->view->res="您今天已经投过票了";<br />$this->render("res");<br />}else{<br /><br />//如果进到这里,说明这个ip是可以投票的,我们先增加他的ip信息,再增加一个票数<br /><br />$recordarr=array(<br />"ip"=>$nowip,<br />"votedate"=>$today,<br />"voteid"=>$voteid<br />);<br /><br /><br />//增加一条记录,如果添加成功返回添加成功的id值<br />$insertres=$record->insert($recordarr);<br />if($insertres){<br />//如果进来,说明添加记录成功,那么我们就直接增加该用户投的对应的一票,下面我们又要操作vote表<br />$vote=new Vote();
Copy after login

------解决思路----------------------
存了占点 可以忽略的磁盘外 运行 会被无视的
------解决思路----------------------
写代码注释要写关键点,有些明显的程序一看就会懂的,就不需要写的,写的话,反而看起来累赘。
------解决思路----------------------
编程中注释是一个非常重要的环节。 当然一眼能看懂的 就跟楼上说的那样。 注释是为了以后方便维护,不会影响运行速度的。
------解决思路----------------------
大段的注释不会影响程序的执行效率

注释分为两类
1、工作流程描述,说明“做什么”
2、算法实现描述,说明“怎么做”

通常 工作流程描述 宜放在程序文件的开始处
算法实现描述 随代码紧要处出现

通常代码块不宜过大,以不超过三个视觉跨度为宜(百行以内,编辑器中翻屏两三次)
过多的行间注释,势必会影响阅读者对算法的理解(看到后面忘了前面)
------解决思路----------------------
撸主的注释语言很有意思,不过感觉有点罗嗦了,个人认为还是简洁些为好,‘我们’俩字也太多了吧
------解决思路----------------------
注释多是好事,但显然lz的注释不是多而是啰嗦了。。语句要简单扼要才好 :)
------解决思路----------------------
php的注释到没所谓,html的注释是占流量的,看上去虽然很微小~
------解决思路----------------------
代码注释量在20%-30%之间为宜,不要用带感情色彩的文字。
<br />//核心功能,没有投票的可以投<br />//投票成功:1.本投票表对应行记录增加一票 2.投票记录表增加该用户的投票记录,投票次数不能大于1。<br /> <br />$voteid=$_GET["voteid"];<br />//获得ID,检测其是否投过票 <br /><br />$nowip=$_SERVER["REMOTE_ADDR"];<br />$today=date("Ymd");<br /> <br /> <br />//是否存在记录<br />$where="ip='$nowip' and votedate='$today'";<br />$record=new Record();<br />$res=$record->fetchAll($where)->toArray();<br />if(count($res) > 10){<br />$this->view->res="您今天已经投过票了";<br />$this->render("res");<br />}else{<br /> <br />//可以投票<br />$recordarr=array(<br />"ip"=>$nowip,<br />"votedate"=>$today,<br />"voteid"=>$voteid<br />);<br /> <br /> <br />//增加一条记录,如果添加成功返回添加成功的id值<br />$insertres=$record->insert($recordarr);<br />if($insertres){<br />//增加该用户投的对应的一票,操作vote表<br />$vote=new Vote();<br />
Copy after login



------解决思路----------------------
等号两边加个空格吧。

------解决思路----------------------
好啊,写了别人看的也清楚,自己也能回想
------解决思路----------------------
我觉不需要太过注意,适量就好。就像吃饭一样,吃多了对胃不好,吃少了就别活了。

适量就好!!!
------解决思路----------------------
哥们,注释简明扼要就好,打中文也挺累的吧?你里面很多一长段话都可以缩略成几个关键词。

<br />/**<br /> * 投票核心处理部分<br /> * 说明:每IP用户每日限制投一票。<br /> * 流程:投票->判断该ip是否在黑名单->【是】中断并提示信息->判断该IP今日是否投票->【是】提示信息;【否】记录ip投票信息,记录投票内容<br /> */<br /><br />$voteid=$_GET["voteid"];<br /><br />//ip<br />$nowip=$_SERVER["REMOTE_ADDR"];<br />$today=date("Ymd");<br /><br />//检查Ip今日是否投票<br />$where="ip='$nowip'?and?votedate='$today'";<br />$record=new?Record();<br />$res=$record->fetchAll($where)->toArray();<br />if(count($res)?>?10){<br />$this->view->res="您今天已经投过票了";<br />$this->render("res");<br />}else{<br />?<br />//记录已投票ip<br />$recordarr=array(<br />"ip"=>$nowip,<br />"votedate"=>$today,<br />"voteid"=>$voteid<br />);<br />$insertres=$record->insert($recordarr);<br /><br />//成功记录ip则记录投票内容<br />if($insertres){<br />//操作vote表<br />$vote=new?Vote();
Copy after login

------解决思路----------------------
关键的地方写上注释就可以了哦,不用那么啰嗦的
------解决思路----------------------
注释不要超过代码就行了,自己给自己看的就看着办吧,要是给别人看的那么就机械点

Statement of this Website
The content of this article is voluntarily contributed by netizens, and the copyright belongs to the original author. This site does not assume corresponding legal responsibility. If you find any content suspected of plagiarism or infringement, please contact admin@php.cn

Hot AI Tools

Undresser.AI Undress

Undresser.AI Undress

AI-powered app for creating realistic nude photos

AI Clothes Remover

AI Clothes Remover

Online AI tool for removing clothes from photos.

Undress AI Tool

Undress AI Tool

Undress images for free

Clothoff.io

Clothoff.io

AI clothes remover

AI Hentai Generator

AI Hentai Generator

Generate AI Hentai for free.

Hot Article

R.E.P.O. Energy Crystals Explained and What They Do (Yellow Crystal)
4 weeks ago By 尊渡假赌尊渡假赌尊渡假赌
R.E.P.O. Best Graphic Settings
4 weeks ago By 尊渡假赌尊渡假赌尊渡假赌
R.E.P.O. How to Fix Audio if You Can't Hear Anyone
4 weeks ago By 尊渡假赌尊渡假赌尊渡假赌
WWE 2K25: How To Unlock Everything In MyRise
1 months ago By 尊渡假赌尊渡假赌尊渡假赌

Hot Tools

Notepad++7.3.1

Notepad++7.3.1

Easy-to-use and free code editor

SublimeText3 Chinese version

SublimeText3 Chinese version

Chinese version, very easy to use

Zend Studio 13.0.1

Zend Studio 13.0.1

Powerful PHP integrated development environment

Dreamweaver CS6

Dreamweaver CS6

Visual web development tools

SublimeText3 Mac version

SublimeText3 Mac version

God-level code editing software (SublimeText3)

Solution: Your organization requires you to change your PIN Solution: Your organization requires you to change your PIN Oct 04, 2023 pm 05:45 PM

The message "Your organization has asked you to change your PIN" will appear on the login screen. This happens when the PIN expiration limit is reached on a computer using organization-based account settings, where they have control over personal devices. However, if you set up Windows using a personal account, the error message should ideally not appear. Although this is not always the case. Most users who encounter errors report using their personal accounts. Why does my organization ask me to change my PIN on Windows 11? It's possible that your account is associated with an organization, and your primary approach should be to verify this. Contacting your domain administrator can help! Additionally, misconfigured local policy settings or incorrect registry keys can cause errors. Right now

How to adjust window border settings on Windows 11: Change color and size How to adjust window border settings on Windows 11: Change color and size Sep 22, 2023 am 11:37 AM

Windows 11 brings fresh and elegant design to the forefront; the modern interface allows you to personalize and change the finest details, such as window borders. In this guide, we'll discuss step-by-step instructions to help you create an environment that reflects your style in the Windows operating system. How to change window border settings? Press + to open the Settings app. WindowsI go to Personalization and click Color Settings. Color Change Window Borders Settings Window 11" Width="643" Height="500" > Find the Show accent color on title bar and window borders option, and toggle the switch next to it. To display accent colors on the Start menu and taskbar To display the theme color on the Start menu and taskbar, turn on Show theme on the Start menu and taskbar

How to change title bar color on Windows 11? How to change title bar color on Windows 11? Sep 14, 2023 pm 03:33 PM

By default, the title bar color on Windows 11 depends on the dark/light theme you choose. However, you can change it to any color you want. In this guide, we'll discuss step-by-step instructions for three ways to change it and personalize your desktop experience to make it visually appealing. Is it possible to change the title bar color of active and inactive windows? Yes, you can change the title bar color of active windows using the Settings app, or you can change the title bar color of inactive windows using Registry Editor. To learn these steps, go to the next section. How to change title bar color in Windows 11? 1. Using the Settings app press + to open the settings window. WindowsI go to "Personalization" and then

OOBELANGUAGE Error Problems in Windows 11/10 Repair OOBELANGUAGE Error Problems in Windows 11/10 Repair Jul 16, 2023 pm 03:29 PM

Do you see "A problem occurred" along with the "OOBELANGUAGE" statement on the Windows Installer page? The installation of Windows sometimes stops due to such errors. OOBE means out-of-the-box experience. As the error message indicates, this is an issue related to OOBE language selection. There is nothing to worry about, you can solve this problem with nifty registry editing from the OOBE screen itself. Quick Fix – 1. Click the “Retry” button at the bottom of the OOBE app. This will continue the process without further hiccups. 2. Use the power button to force shut down the system. After the system restarts, OOBE should continue. 3. Disconnect the system from the Internet. Complete all aspects of OOBE in offline mode

How to enable or disable taskbar thumbnail previews on Windows 11 How to enable or disable taskbar thumbnail previews on Windows 11 Sep 15, 2023 pm 03:57 PM

Taskbar thumbnails can be fun, but they can also be distracting or annoying. Considering how often you hover over this area, you may have inadvertently closed important windows a few times. Another disadvantage is that it uses more system resources, so if you've been looking for a way to be more resource efficient, we'll show you how to disable it. However, if your hardware specs can handle it and you like the preview, you can enable it. How to enable taskbar thumbnail preview in Windows 11? 1. Using the Settings app tap the key and click Settings. Windows click System and select About. Click Advanced system settings. Navigate to the Advanced tab and select Settings under Performance. Select "Visual Effects"

What are the differences between Huawei GT3 Pro and GT4? What are the differences between Huawei GT3 Pro and GT4? Dec 29, 2023 pm 02:27 PM

Many users will choose the Huawei brand when choosing smart watches. Among them, Huawei GT3pro and GT4 are very popular choices. Many users are curious about the difference between Huawei GT3pro and GT4. Let’s introduce the two to you. . What are the differences between Huawei GT3pro and GT4? 1. Appearance GT4: 46mm and 41mm, the material is glass mirror + stainless steel body + high-resolution fiber back shell. GT3pro: 46.6mm and 42.9mm, the material is sapphire glass + titanium body/ceramic body + ceramic back shell 2. Healthy GT4: Using the latest Huawei Truseen5.5+ algorithm, the results will be more accurate. GT3pro: Added ECG electrocardiogram and blood vessel and safety

Display scaling guide on Windows 11 Display scaling guide on Windows 11 Sep 19, 2023 pm 06:45 PM

We all have different preferences when it comes to display scaling on Windows 11. Some people like big icons, some like small icons. However, we all agree that having the right scaling is important. Poor font scaling or over-scaling of images can be a real productivity killer when working, so you need to know how to customize it to get the most out of your system's capabilities. Advantages of Custom Zoom: This is a useful feature for people who have difficulty reading text on the screen. It helps you see more on the screen at one time. You can create custom extension profiles that apply only to certain monitors and applications. Can help improve the performance of low-end hardware. It gives you more control over what's on your screen. How to use Windows 11

10 Ways to Adjust Brightness on Windows 11 10 Ways to Adjust Brightness on Windows 11 Dec 18, 2023 pm 02:21 PM

Screen brightness is an integral part of using modern computing devices, especially when you look at the screen for long periods of time. It helps you reduce eye strain, improve legibility, and view content easily and efficiently. However, depending on your settings, it can sometimes be difficult to manage brightness, especially on Windows 11 with the new UI changes. If you're having trouble adjusting brightness, here are all the ways to manage brightness on Windows 11. How to Change Brightness on Windows 11 [10 Ways Explained] Single monitor users can use the following methods to adjust brightness on Windows 11. This includes desktop systems using a single monitor as well as laptops. let's start. Method 1: Use the Action Center The Action Center is accessible

See all articles