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

您的位置:首頁(yè)技術(shù)文章
文章詳情頁(yè)

PHP代碼注釋小細(xì)節(jié)

瀏覽:83日期:2022-09-11 16:40:33
代碼注釋,可以說(shuō)是比代碼本身更重要。告誡新人,一定要養(yǎng)成寫(xiě)注釋的習(xí)慣,否則只能是損人不利己。這里有一些方法可以確保你寫(xiě)在代碼中的注釋是友好的,總結(jié)起來(lái)就是'5要與3不要'一、不要重復(fù)閱讀者已經(jīng)知道的內(nèi)容(×)一些光看方法名,光看代碼就能看出來(lái)功能的就沒(méi)必要寫(xiě)注釋,// If the color is red, turn it greenif (color.is_red()) { color.turn_green();}二、要注釋說(shuō)明推理和歷史(√)如果代碼中的業(yè)務(wù)邏輯以后可能需要更新或更改,那就應(yīng)該留下注釋:/* 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++) { ...}三、同一行的注釋不要寫(xiě)得很長(zhǎng)(×)沒(méi)什么比拖動(dòng)水平滾動(dòng)條來(lái)閱讀注釋更令開(kāi)發(fā)人員發(fā)指的了。事實(shí)上,大多數(shù)開(kāi)發(fā)人員都會(huì)選擇忽略這類注釋,因?yàn)樽x起來(lái)真的很不方便。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}四、要把長(zhǎng)注釋放在邏輯上面,短注釋放在后面(√)注釋如果不超過(guò)120個(gè)字符那可以放在代碼旁邊。否則,就應(yīng)該直接把注釋放到語(yǔ)句上面。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; } };}五、不要為了注釋而添加不必要的注釋(×)畫(huà)蛇添足的注釋會(huì)造成混亂。也許在學(xué)校里老師教你要給所有語(yǔ)句添加注釋,這會(huì)幫助開(kāi)發(fā)人員更好地理解。但這是錯(cuò)的。誰(shuí)要這么說(shuō),那你就立馬上給他個(gè)兩大耳刮子。代碼應(yīng)該保持干凈簡(jiǎn)潔,這是毋庸置疑的。如果你的代碼需要逐行解釋說(shuō)明,那么你最需要做的是重構(gòu)。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}六、注釋要拼寫(xiě)正確(√)不要為代碼注釋中的拼寫(xiě)錯(cuò)誤找借口。IDE可以為你檢查拼寫(xiě)。如果沒(méi)有這個(gè)功能,那就去下載插件,自己動(dòng)手!七、要多多練習(xí)(√)熟能生巧。試著寫(xiě)一些有用的注釋,可以問(wèn)問(wèn)其他開(kāi)發(fā)人員你的注釋是否有用。隨著時(shí)間的推移,你會(huì)慢慢懂得怎樣才算是友好的注釋。八、要審查別人的注釋(√)在代碼審查時(shí),我們往往會(huì)忽略查看注釋。不要怕要求更多的注釋,你應(yīng)該提出質(zhì)疑。如果每個(gè)人都養(yǎng)成寫(xiě)好注釋的好習(xí)慣,那么世界將會(huì)更美好。九、對(duì)注釋一定要知道的的精華總結(jié)注釋是開(kāi)發(fā)進(jìn)程中非常重要的一部分,但我們不應(yīng)該為了注釋而注釋。注釋?xiě)?yīng)該是有用的,簡(jiǎn)潔的,應(yīng)該是對(duì)代碼的一種補(bǔ)充。注釋不應(yīng)該用于逐行地解釋代碼,相反,它應(yīng)該用于解釋業(yè)務(wù)邏輯,推理以及對(duì)將來(lái)的啟示。
標(biāo)簽: PHP
相關(guān)文章:
主站蜘蛛池模板: B2B网站_B2B免费发布信息网站_B2B企业贸易平台 - 企资网 | 隐形纱窗|防护纱窗|金刚网防盗纱窗|韦柏纱窗|上海青木装潢制品有限公司|纱窗国标起草单位 | 东亚液氮罐-液氮生物容器-乐山市东亚机电工贸有限公司 | PSI渗透压仪,TPS酸度计,美国CHAI PCR仪,渗透压仪厂家_价格,微生物快速检测仪-华泰和合(北京)商贸有限公司 | 地埋式垃圾站厂家【佳星环保】小区压缩垃圾中转站转运站 | 铝镁锰板厂家_进口钛锌板_铝镁锰波浪板_铝镁锰墙面板_铝镁锰屋面-杭州军晟金属建筑材料 | 万家财经_财经新闻_在线财经资讯网 | DDoS安全防护官网-领先的DDoS安全防护服务商| 镀锌方管,无缝方管,伸缩套管,方矩管_山东重鑫致胜金属制品有限公司 | 达利园物流科技集团-| 北京租车公司_汽车/客车/班车/大巴车租赁_商务会议/展会用车/旅游大巴出租_北京桐顺创业租车公司 | 广东燎了网络科技有限公司官网-网站建设-珠海网络推广-高端营销型外贸网站建设-珠海专业h5建站公司「了了网」 | 地脚螺栓_材质_标准-永年县德联地脚螺栓厂家 | 动力配电箱-不锈钢配电箱-高压开关柜-重庆宇轩机电设备有限公司 聚天冬氨酸,亚氨基二琥珀酸四钠,PASP,IDS - 远联化工 | Dataforth隔离信号调理模块-信号放大模块-加速度振动传感器-北京康泰电子有限公司 | 翻斗式矿车|固定式矿车|曲轨侧卸式矿车|梭式矿车|矿车配件-山东卓力矿车生产厂家 | 数显恒温油浴-电砂浴-高温油浴振荡器-常州迈科诺仪器有限公司 | 沈阳真空机_沈阳真空包装机_沈阳大米真空包装机-沈阳海鹞真空包装机械有限公司 | 行吊_电动单梁起重机_双梁起重机_合肥起重机_厂家_合肥市神雕起重机械有限公司 | 书法培训-高考书法艺考培训班-山东艺霖书法培训凭实力挺进央美 | 餐饮加盟网_特色餐饮加盟店_餐饮连锁店加盟 | 爱佩恒温恒湿测试箱|高低温实验箱|高低温冲击试验箱|冷热冲击试验箱-您身边的模拟环境试验设备技术专家-合作热线:400-6727-800-广东爱佩试验设备有限公司 | 二手色谱仪器,十万分之一分析天平,蒸发光检测器,电位滴定仪-湖北捷岛科学仪器有限公司 | 电磁流量计_智能防腐防爆管道式计量表-金湖凯铭仪表有限公司 | 吨袋包装机|吨包秤|吨包机|集装袋包装机-烟台华恩科技 | 外观设计_设备外观设计_外观设计公司_产品外观设计_机械设备外观设计_东莞工业设计公司-意品深蓝 | 电动球阀_不锈钢电动球阀_电动三通球阀_电动调节球阀_上海湖泉阀门有限公司 | 全自动不干胶贴标机_套标机-上海今昂贴标机生产厂家 | 商标转让-购买商标专业|放心的商标交易网-蜀易标商标网 | 广州番禺搬家公司_天河黄埔搬家公司_企业工厂搬迁_日式搬家_广州搬家公司_厚道搬迁搬家公司 | 香港新时代国际美容美发化妆美甲培训学校-26年培训经验,值得信赖! | 定制/定做冲锋衣厂家/公司-订做/订制冲锋衣价格/费用-北京圣达信 | 深圳宣传片制作_产品视频制作_深圳3D动画制作公司_深圳短视频拍摄-深圳市西典映画传媒有限公司 | 蓝米云-专注于高性价比香港/美国VPS云服务器及海外公益型免费虚拟主机 | 无线联网门锁|校园联网门锁|学校智能门锁|公租房智能门锁|保障房管理系统-KEENZY中科易安 | 建大仁科-温湿度变送器|温湿度传感器|温湿度记录仪_厂家_价格-山东仁科 | CCE素质教育博览会 | CCE素博会 | 教育展 | 美育展 | 科教展 | 素质教育展 | 自动钻孔机-全自动数控钻孔机生产厂家-多米(广东)智能装备有限公司 | 南京种植牙医院【官方挂号】_南京治疗种植牙医院那个好_南京看种植牙哪里好_南京茀莱堡口腔医院 尼龙PA610树脂,尼龙PA612树脂,尼龙PA1010树脂,透明尼龙-谷骐科技【官网】 | 挤出机_橡胶挤出机_塑料挤出机_胶片冷却机-河北伟源橡塑设备有限公司 | 微妙网,专业的动画师、特效师、CG模型设计师网站! - wmiao.com 超声波电磁流量计-液位计-孔板流量计-料位计-江苏信仪自动化仪表有限公司 |