目次
ディスカッションへの返信(解決策)
ホームページ バックエンド開発 PHPチュートリアル PHPプログラムにコメントをたくさん書くのは良いことなのでしょうか?

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

Jun 23, 2016 pm 01:44 PM

大量のコメントを含む PHP コードを作成すると、PHP の実行パフォーマンスに悪影響が出ますか?
コメントが多すぎて、コードそのものよりも時間が余ってしまいました。何かデメリットはあるのでしょうか?


例:

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


ディスカッションへの返信(解決策)

保存されたポイントは無視でき、ディスク外での実行は無視されます

コードのコメントを書くときは、重要なポイントを書く必要があります。当たり前の手順 読めばわかるなら書かなくてもいいです 書いてしまうと面倒に見えます。

コメントはプログラミングの非常に重要な部分です。もちろん、上で述べたように、一目で理解できます。注釈は将来のメンテナンスを容易にするためのものであり、実行速度には影響しません。

コメントの大きな段落はプログラムの実行効率には影響しません

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

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

通常、コード ブロックは大きすぎてはならず、ビジュアル スパンが 3 つ以下である必要があります (
パス 行間のコメントが多すぎると、必然的に読者のアルゴリズムの理解に影響を及ぼします (読んだ後、前の部分を忘れてしまいます)

Luzhu のコメント言語は非常に興味深いですが、個人的には、もっと簡潔にしたほうがいいと思います。「We 」は言葉が多すぎます

コメントが増えるのは良いことですが、明らかに lz のコメントは多すぎるわけではありませんが、冗長すぎます。 。ステートメントはシンプルかつ簡潔である必要があります:)

PHP コメントは重要ではありません。HTML コメントはトラフィックを考慮しますが、非常に少ないように見えます ~

コード コメントの量は 20% ~ 30% が適切で、タグは使用しないでください感情的なテキスト。

//核心功能,没有投票的可以投//投票成功:1.本投票表对应行记录增加一票 2.投票记录表增加该用户的投票记录,投票次数不能大于1。 $voteid=$_GET["voteid"];//获得ID,检测其是否投过票 $nowip=$_SERVER["REMOTE_ADDR"];$today=date("Ymd");  //是否存在记录$where="ip='$nowip' and votedate='$today'";$record=new Record();$res=$record->fetchAll($where)->toArray();if(count($res) > 10){$this->view->res="您今天已经投过票了";$this->render("res");}else{ //可以投票$recordarr=array("ip"=>$nowip,"votedate"=>$today,"voteid"=>$voteid);  //增加一条记录,如果添加成功返回添加成功的id值$insertres=$record->insert($recordarr);if($insertres){//增加该用户投的对应的一票,操作vote表$vote=new Vote();
ログイン後にコピー


等号の両側にスペースを追加します。

そうですね、書けば他の人もよくわかりますし、自分でも思い出すことができます

あまり気にしすぎなくても大丈夫だと思います。食事と同じように、食べ過ぎは胃に悪いし、食べ過ぎは胃に悪くなります。

ちょうどいい量です! ! !

兄弟、コメントは要点を簡潔にまとめてください。中国語で入力するのはとても疲れますよね。長い段落の多くは、いくつかのキーワードに短縮できます。

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

重要な場所にコメントを書くだけです。冗長にする必要はありません

コメントはコードを超えてはなりません。他の人に見せたい場合は、それ以上にしてください。機械的

コメントの口調はちょっと小学生に教える先生みたい

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

ホットAIツール

Undresser.AI Undress

Undresser.AI Undress

リアルなヌード写真を作成する AI 搭載アプリ

AI Clothes Remover

AI Clothes Remover

写真から衣服を削除するオンライン AI ツール。

Undress AI Tool

Undress AI Tool

脱衣画像を無料で

Clothoff.io

Clothoff.io

AI衣類リムーバー

AI Hentai Generator

AI Hentai Generator

AIヘンタイを無料で生成します。

ホットツール

メモ帳++7.3.1

メモ帳++7.3.1

使いやすく無料のコードエディター

SublimeText3 中国語版

SublimeText3 中国語版

中国語版、とても使いやすい

ゼンドスタジオ 13.0.1

ゼンドスタジオ 13.0.1

強力な PHP 統合開発環境

ドリームウィーバー CS6

ドリームウィーバー CS6

ビジュアル Web 開発ツール

SublimeText3 Mac版

SublimeText3 Mac版

神レベルのコード編集ソフト(SublimeText3)

JSON Web Tokens(JWT)とPHP APIでのユースケースを説明してください。 JSON Web Tokens(JWT)とPHP APIでのユースケースを説明してください。 Apr 05, 2025 am 12:04 AM

JWTは、JSONに基づくオープン標準であり、主にアイデンティティ認証と情報交換のために、当事者間で情報を安全に送信するために使用されます。 1。JWTは、ヘッダー、ペイロード、署名の3つの部分で構成されています。 2。JWTの実用的な原則には、JWTの生成、JWTの検証、ペイロードの解析という3つのステップが含まれます。 3. PHPでの認証にJWTを使用する場合、JWTを生成および検証でき、ユーザーの役割と許可情報を高度な使用に含めることができます。 4.一般的なエラーには、署名検証障害、トークンの有効期限、およびペイロードが大きくなります。デバッグスキルには、デバッグツールの使用とロギングが含まれます。 5.パフォーマンスの最適化とベストプラクティスには、適切な署名アルゴリズムの使用、有効期間を合理的に設定することが含まれます。

確固たる原則と、それらがPHP開発にどのように適用されるかを説明してください。 確固たる原則と、それらがPHP開発にどのように適用されるかを説明してください。 Apr 03, 2025 am 12:04 AM

PHP開発における固体原理の適用には、次のものが含まれます。1。単一責任原則(SRP):各クラスは1つの機能のみを担当します。 2。オープンおよびクローズ原理(OCP):変更は、変更ではなく拡張によって達成されます。 3。Lischの代替原則(LSP):サブクラスは、プログラムの精度に影響を与えることなく、基本クラスを置き換えることができます。 4。インターフェイス分離原理(ISP):依存関係や未使用の方法を避けるために、細粒インターフェイスを使用します。 5。依存関係の反転原理(DIP):高レベルのモジュールと低レベルのモジュールは抽象化に依存し、依存関係噴射を通じて実装されます。

システムの再起動後にUnixSocketの権限を自動的に設定する方法は? システムの再起動後にUnixSocketの権限を自動的に設定する方法は? Mar 31, 2025 pm 11:54 PM

システムが再起動した後、UnixSocketの権限を自動的に設定する方法。システムが再起動するたびに、UnixSocketの許可を変更するために次のコマンドを実行する必要があります:sudo ...

PHPにおける後期静的結合の概念を説明します。 PHPにおける後期静的結合の概念を説明します。 Mar 21, 2025 pm 01:33 PM

記事では、PHP 5.3で導入されたPHPの後期静的結合(LSB)について説明し、より柔軟な継承を求める静的メソッドコールのランタイム解像度を可能にします。 LSBの実用的なアプリケーションと潜在的なパフォーマ

PHPのCurlライブラリを使用してJSONデータを含むPOSTリクエストを送信する方法は? PHPのCurlライブラリを使用してJSONデータを含むPOSTリクエストを送信する方法は? Apr 01, 2025 pm 03:12 PM

PHP開発でPHPのCurlライブラリを使用してJSONデータを送信すると、外部APIと対話する必要があることがよくあります。一般的な方法の1つは、Curlライブラリを使用して投稿を送信することです。

フレームワークセキュリティ機能:脆弱性から保護します。 フレームワークセキュリティ機能:脆弱性から保護します。 Mar 28, 2025 pm 05:11 PM

記事では、入力検証、認証、定期的な更新など、脆弱性から保護するためのフレームワークの重要なセキュリティ機能について説明します。

フレームワークのカスタマイズ/拡張:カスタム機能を追加する方法。 フレームワークのカスタマイズ/拡張:カスタム機能を追加する方法。 Mar 28, 2025 pm 05:12 PM

この記事では、フレームワークにカスタム機能を追加し、アーキテクチャの理解、拡張ポイントの識別、統合とデバッグのベストプラクティスに焦点を当てています。

See all articles