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

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

PHP代碼注釋小細節

瀏覽:82日期: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
相關文章:
主站蜘蛛池模板: ge超声波测厚仪-电动涂膜机-电动划格仪-上海洪富 | 混合反应量热仪-高温高压量热仪-微机差热分析仪DTA|凯璞百科 | 家乐事净水器官网-净水器厂家「官方」 | ptc_浴霸_大巴_干衣机_呼吸机_毛巾架_电动车加热器-上海帕克 | 溶氧传感器-pH传感器|哈美顿(hamilton) | led太阳能路灯厂家价格_风光互补庭院灯_农村市政工程路灯-中山华可路灯品牌 | 卫生纸复卷机|抽纸机|卫生纸加工设备|做卫生纸机器|小型卫生纸加工需要什么设备|卫生纸机器设备多少钱一台|许昌恒源纸品机械有限公司 | BOE画框屏-触摸一体机-触控查询一体机-触摸屏一体机价格-厂家直销-触发电子 | 小型铜米机-干式铜米机-杂线全自动铜米机-河南鑫世昌机械制造有限公司 | 珠海白蚁防治_珠海灭鼠_珠海杀虫灭鼠_珠海灭蟑螂_珠海酒店消杀_珠海工厂杀虫灭鼠_立净虫控防治服务有限公司 | 我车网|我关心的汽车资讯_汽车图片_汽车生活! | 河南包装袋厂家_河南真空袋批发价格_河南服装袋定制-恒源达包装制品 | 南京技嘉环保科技有限公司-杀菌除臭剂|污水|垃圾|厕所|橡胶厂|化工厂|铸造厂除臭剂 | 机制砂选粉机_砂石选粉机厂家-盐城市助成粉磨科技有限公司 | 交流伺服电机|直流伺服|伺服驱动器|伺服电机-深圳市华科星电气有限公司 | STRO|DTRO-STRO反渗透膜(科普)_碟滤 | 齿轮减速机电机一体机_齿轮减速箱加电机一体化-德国BOSERL蜗轮蜗杆减速机电机生产厂家 | 真空上料机(一种真空输送机)-百科 | TPM咨询,精益生产管理,5S,6S现场管理培训_华谋咨询公司 | 流量检测仪-气密性检测装置-密封性试验仪-东莞市奥图自动化科技有限公司 | 昆山PCB加工_SMT贴片_PCB抄板_线路板焊接加工-昆山腾宸电子科技有限公司 | 密集架|电动密集架|移动密集架|黑龙江档案密集架-大量现货厂家销售 | 粉末包装机-给袋式包装机-全自动包装机-颗粒-液体-食品-酱腌菜包装机生产线【润立机械】 | Safety light curtain|Belt Sway Switches|Pull Rope Switch|ultrasonic flaw detector-Shandong Zhuoxin Machinery Co., Ltd | 穿线管|波纹穿线管|包塑金属软管|蛇皮管?闵彬专注弱电工程? | 3d可视化建模_三维展示_产品3d互动数字营销_三维动画制作_3D虚拟商城 【商迪3D】三维展示服务商 广东健伦体育发展有限公司-体育工程配套及销售运动器材的体育用品服务商 | 新型锤式破碎机_新型圆锥式_新型颚式破碎机_反击式打沙机_锤式制砂机_青州建源机械 | 化工ERP软件_化工新材料ERP系统_化工新材料MES软件_MES系统-广东顺景软件科技有限公司 | 大_小鼠elisa试剂盒-植物_人Elisa试剂盒-PCR荧光定量试剂盒-上海一研生物科技有限公司 | 骨龄仪_骨龄检测仪_儿童骨龄测试仪_品牌生产厂家【品源医疗】 | 污水/卧式/潜水/钻井/矿用/大型/小型/泥浆泵,价格,参数,型号,厂家 - 安平县鼎千泵业制造厂 | 碳化硅,氮化硅,冰晶石,绢云母,氟化铝,白刚玉,棕刚玉,石墨,铝粉,铁粉,金属硅粉,金属铝粉,氧化铝粉,硅微粉,蓝晶石,红柱石,莫来石,粉煤灰,三聚磷酸钠,六偏磷酸钠,硫酸镁-皓泉新材料 | 渣油泵,KCB齿轮泵,不锈钢齿轮泵,重油泵,煤焦油泵,泊头市泰邦泵阀制造有限公司 | hdpe土工膜-防渗膜-复合土工膜-长丝土工布价格-厂家直销「恒阳新材料」-山东恒阳新材料有限公司 ETFE膜结构_PTFE膜结构_空间钢结构_膜结构_张拉膜_浙江萬豪空间结构集团有限公司 | 数控走心机-走心机价格-双主轴走心机-宝宇百科 | 挤奶设备过滤纸,牛奶过滤纸,挤奶机过滤袋-济南蓝贝尔工贸有限公司 | 喷码机,激光喷码打码机,鸡蛋打码机,手持打码机,自动喷码机,一物一码防伪溯源-恒欣瑞达有限公司 | ◆大型吹塑加工|吹塑加工|吹塑代加工|吹塑加工厂|吹塑设备|滚塑加工|滚塑代加工-莱力奇塑业有限公司 | 智能垃圾箱|垃圾房|垃圾分类亭|垃圾分类箱专业生产厂家定做-宿迁市传宇环保设备有限公司 | 飞利浦LED体育场灯具-吸顶式油站灯-飞利浦LED罩棚灯-佛山嘉耀照明有限公司 | 高效节能电机_伺服主轴电机_铜转子电机_交流感应伺服电机_图片_型号_江苏智马科技有限公司 |