电脑知识|欧美黑人一区二区三区|软件|欧美黑人一级爽快片淫片高清|系统|欧美黑人狂野猛交老妇|数据库|服务器|编程开发|网络运营|知识问答|技术教程文章 - 好吧啦网

您的位置:首頁技術文章
文章詳情頁

PHP代碼注釋小細節

瀏覽:84日期:2022-09-11 16:40:33
代碼注釋,可以說是比代碼本身更重要。告誡新人,一定要養成寫注釋的習慣,否則只能是損人不利己。這里有一些方法可以確保你寫在代碼中的注釋是友好的,總結起來就是'5要與3不要'一、不要重復閱讀者已經知道的內容(×)一些光看方法名,光看代碼就能看出來功能的就沒必要寫注釋,// If the color is red, turn it greenif (color.is_red()) { color.turn_green();}二、要注釋說明推理和歷史(√)如果代碼中的業務邏輯以后可能需要更新或更改,那就應該留下注釋:/* The API currently returns an array of itemseven though that will change in an upcoming ticket.Therefore, be sure to change the loop style here so thatwe properly iterate over an object */var api_result = {items: ['one', 'two']}, items = api_result.items, num_items = items.length;for(var x = 0; x < num_items; x++) { ...}三、同一行的注釋不要寫得很長(×)沒什么比拖動水平滾動條來閱讀注釋更令開發人員發指的了。事實上,大多數開發人員都會選擇忽略這類注釋,因為讀起來真的很不方便。function Person(name) { this.name = name; this.first_name = name.split(' ')[0]; // This is just a shot in the dark here. If we can extract the first name, let’s do it}四、要把長注釋放在邏輯上面,短注釋放在后面(√)注釋如果不超過120個字符那可以放在代碼旁邊。否則,就應該直接把注釋放到語句上面。if (person.age < 21) { person.can_drink = false; // 21 drinking age /* Fees are given to those under 25, but only in some states. */ person.has_car_rental_fee = function(state) { if (state === 'MI') { return true; } };}五、不要為了注釋而添加不必要的注釋(×)畫蛇添足的注釋會造成混亂。也許在學校里老師教你要給所有語句添加注釋,這會幫助開發人員更好地理解。但這是錯的。誰要這么說,那你就立馬上給他個兩大耳刮子。代碼應該保持干凈簡潔,這是毋庸置疑的。如果你的代碼需要逐行解釋說明,那么你最需要做的是重構。if (person.age >= 21) { person.can_drink = true; // A person can drink at 21 person.can_smoke = true; // A person can smoke at 18 person.can_wed = true; // A person can get married at 18 person.can_see_all_movies = true; // A person can see all movies at 17 //I hate babies and children and all things pure because I comment too much}六、注釋要拼寫正確(√)不要為代碼注釋中的拼寫錯誤找借口。IDE可以為你檢查拼寫。如果沒有這個功能,那就去下載插件,自己動手!七、要多多練習(√)熟能生巧。試著寫一些有用的注釋,可以問問其他開發人員你的注釋是否有用。隨著時間的推移,你會慢慢懂得怎樣才算是友好的注釋。八、要審查別人的注釋(√)在代碼審查時,我們往往會忽略查看注釋。不要怕要求更多的注釋,你應該提出質疑。如果每個人都養成寫好注釋的好習慣,那么世界將會更美好。九、對注釋一定要知道的的精華總結注釋是開發進程中非常重要的一部分,但我們不應該為了注釋而注釋。注釋應該是有用的,簡潔的,應該是對代碼的一種補充。注釋不應該用于逐行地解釋代碼,相反,它應該用于解釋業務邏輯,推理以及對將來的啟示。
標簽: PHP
相關文章:
主站蜘蛛池模板: 北京宣传片拍摄_产品宣传片拍摄_宣传片制作公司-现像传媒 | 石牌坊价格石牌坊雕刻制作_石雕牌坊牌楼石栏杆厂家_山东嘉祥石雕有限公司 | WTB5光栅尺-JIE WILL磁栅尺-B60数显表-常州中崴机电科技有限公司 | 北京租车公司_汽车/客车/班车/大巴车租赁_商务会议/展会用车/旅游大巴出租_北京桐顺创业租车公司 | 户外健身路径_小区健身器材_室外健身器材厂家_价格-浩然体育 | 纯化水设备-EDI-制药-实验室-二级反渗透-高纯水|超纯水设备 | 多功能三相相位伏安表-变压器短路阻抗测试仪-上海妙定电气 | 水性漆|墙面漆|木器家具漆|水漆涂料_晨阳水漆官网 | 复盛空压机配件-空气压缩机-复盛空压机(华北)总代理 | 路斯特伺服驱动器维修,伦茨伺服驱动器维修|万骏自动化百科 | 智慧物联网行业一站式解决方案提供商-北京东成基业 | 氟氨基酮、氯硝柳胺、2-氟苯甲酸、异香兰素-新晨化工 | 塑料检查井_双扣聚氯乙烯增强管_双壁波纹管-河南中盈塑料制品有限公司 | 北钻固控设备|石油钻采设备-石油固控设备厂家 | IP检测-检测您的IP质量 | 陕西华春网络科技股份有限公司| 刮板输送机,粉尘加湿搅拌机,螺旋输送机,布袋除尘器 | 谈股票-今日股票行情走势分析-牛股推荐排行榜 | 高低温老化试验机-步入式/低温恒温恒湿试验机-百科 | 食药成分检测_调料配方还原_洗涤剂化学成分分析_饲料_百检信息科技有限公司 | 电磁流量计厂家_涡街流量计厂家_热式气体流量计-青天伟业仪器仪表有限公司 | 西门子伺服电机维修,西门子电源模块维修,西门子驱动模块维修-上海渠利 | 不锈钢螺丝 - 六角螺丝厂家 - 不锈钢紧固件 - 万千紧固件--紧固件一站式采购 | 济南铝方通-济南铝方通价格-济南方通厂家-山东鲁方通建材有限公司 | 小程序开发公司-小程序制作-微信小程序开发-小程序定制-咏熠软件 | 气动隔膜泵-电动隔膜泵-循环热水泵-液下排污/螺杆/管道/化工泵「厂家」浙江绿邦 | 威实软件_软件定制开发_OA_OA办公系统_OA系统_办公自动化软件 | 医养体检包_公卫随访箱_慢病随访包_家签随访包_随访一体机-济南易享医疗科技有限公司 | 齿轮减速机电机一体机_齿轮减速箱加电机一体化-德国BOSERL蜗轮蜗杆减速机电机生产厂家 | 阳光模拟试验箱_高低温试验箱_高低温冲击试验箱_快速温变试验箱|东莞市赛思检测设备有限公司 | 济南品牌包装设计公司_济南VI标志设计公司_山东锐尚文化传播 | 防爆电机生产厂家,YBK3电动机,YBX3系列防爆电机,YBX4节防爆电机--河南省南洋防爆电机有限公司 | 挤出熔体泵_高温熔体泵_熔体出料泵_郑州海科熔体泵有限公司 | 圣才学习网-考研考证学习平台,提供万种考研考证电子书、题库、视频课程等考试资料 | 小型手持气象站-空气负氧离子监测站-多要素微气象传感器-山东天合环境科技有限公司 | 上海噪音治理公司-专业隔音降噪公司-中广通环保 | 【铜排折弯机,钢丝折弯成型机,汽车发泡钢丝折弯机,线材折弯机厂家,线材成型机,铁线折弯机】贝朗折弯机厂家_东莞市贝朗自动化设备有限公司 | 专注提供国外机电设备及配件-工业控制领域一站式服务商-深圳市华联欧国际贸易有限公司 | 制氮设备_PSA制氮机_激光切割制氮机_氮气机生产厂家-苏州西斯气体设备有限公司 | 南京试剂|化学试剂|分析试剂|实验试剂|cas号查询-专业60年试剂销售企业 | 博莱特空压机|博莱特-阿特拉斯独资空压机品牌核心代理商 |