ホームページ >バックエンド開発 >PHPチュートリアル >PHPプログラムにコメントをたくさん書くのは良いことなのでしょうか?解決方法

PHPプログラムにコメントをたくさん書くのは良いことなのでしょうか?解決方法

WBOY
WBOYオリジナル
2016-06-13 12:10:471276ブラウズ

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();

-----ソリューションアイデア-------------- - ------
占有ディスクを保存して無視できる場合、実行しても無視されます
-----解決策のアイデア---- --- ---------------
コードのコメントを書くときは、一目でわかるようなプログラムは要点をメモしておくといいでしょう。書く必要があるので、書くと面倒に思えます。
------解決策のアイデア----------------------
プログラミングリンクではコメントは非常に重要です。もちろん、上で述べたように、一目で理解できます。注釈は将来のメンテナンスを容易にするためのものであり、実行速度には影響しません。
------解決策のアイデア----------------------
大きな段落コメントはプログラムに影響を与えません実行効率

コメントは 2 つのカテゴリに分類されます
1. 「何を行うか」を説明するワークフローの説明
2. 「どのように行うか」を説明するアルゴリズム実装の説明

通常は作業プロセスの説明はプログラム ファイルの先頭に配置する必要があります
アルゴリズム実装の説明はコードの重要なポイントとともに表示されます

通常、コード ブロックは大きすぎてはならず、ビジュアル 3 つ以下である必要がありますスパン (100 行以内、エディタは画面を 2 ~ 3 回回転させます)
行間のコメントが多すぎると、読者のアルゴリズムの理解に必然的に影響します (後半を見ると前の部分を忘れてしまいます)
------解決策のアイデア--- -------------------
Luzhu の注釈の言語は非常に興味深いですが、個人的には、「私たち」は言葉が多すぎます
-----解決策のアイデア----------- ともっと簡潔にした方が良いと思います。 -----------
コメントが増えるのは良いことですが、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 />



-----ソリューションのアイデア----------------------
等号の両側にスペースを追加します。

-----解決策のアイデア----------------------
わかりました、書きました他の人はそれをはっきりと見ることができ、私もそれを思い出すことができます
-----解決策のアイデア----------------------
あまり気を遣う必要はなく、ちょうど良いくらいだと思います。食事と同じように、食べ過ぎは胃に悪いし、食べ過ぎは胃に悪くなります。

ちょうどいい量! ! !
------解決策のアイデア----------------------
兄弟、コメントは簡潔にしてください。中国語で入力するのはかなり疲れますよね?長い段落の多くは、いくつかのキーワードに短縮できます。

<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();

-----ソリューションのアイデア----------------------
重要な場所にコメントを書くだけで、それほど冗長にする必要はありません
------解決策のアイデア-------
自分に見せたい場合は、コード以上のコメントをしないでください。他の人に見せたい場合は、もっと機械的にしてください。

声明:
この記事の内容はネチズンが自主的に寄稿したものであり、著作権は原著者に帰属します。このサイトは、それに相当する法的責任を負いません。盗作または侵害の疑いのあるコンテンツを見つけた場合は、admin@php.cn までご連絡ください。