PHP程式寫大量注釋好嗎?

來源:互聯網
上載者:User
我寫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();


回複討論(解決方案)

存了占點 可以忽略的磁碟外 運行 會被無視的

寫代碼注釋要寫關鍵點,有些明顯的程式一看就會懂的,就不需要寫的,寫的話,反而看起來累贅。

編程中注釋是一個非常重要的環節。 當然一眼能看懂的 就跟樓上說的那樣。 注釋是為了以後方便維護,不會影響運行速度的。

大段的注釋不會影響程式的執行效率

注釋分為兩類
1、工作流程描述,說明“做什麼”
2、演算法實現描述,說明“怎麼做”

通常 工作流程描述 宜放在程式檔案的開始處
演算法實現描述 隨代碼緊要處出現

通常代碼塊不宜過大,以不超過三個視覺跨度為宜(百行以內,編輯器中翻屏兩三次)
過多的行間注釋,勢必會影響閱讀者對演算法的理解(看到後面忘了前面)

擼主的注釋語言很有意思,不過感覺有點羅嗦了,個人認為還是簡潔些為好,‘我們’倆字也太多了吧

注釋多是好事,但顯然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();

關鍵的地方寫上注釋就可以了哦,不用那麼?嗦的

注釋不要超過代碼就行了,自己給自己看的就看著辦吧,要是給別人看的那麼就機械點

注釋的口氣有點像老師在教小學生

  • 聯繫我們

    該頁面正文內容均來源於網絡整理,並不代表阿里雲官方的觀點,該頁面所提到的產品和服務也與阿里云無關,如果該頁面內容對您造成了困擾,歡迎寫郵件給我們,收到郵件我們將在5個工作日內處理。

    如果您發現本社區中有涉嫌抄襲的內容,歡迎發送郵件至: info-contact@alibabacloud.com 進行舉報並提供相關證據,工作人員會在 5 個工作天內聯絡您,一經查實,本站將立刻刪除涉嫌侵權內容。

    A Free Trial That Lets You Build Big!

    Start building with 50+ products and up to 12 months usage for Elastic Compute Service

    • Sales Support

      1 on 1 presale consultation

    • After-Sales Support

      24/7 Technical Support 6 Free Tickets per Quarter Faster Response

    • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.