地址: 上海市靜安區(qū)共和新路4718弄10號樓2樓
熱線:400-166-3538
電話:19301461038
郵箱:sales@shyuanzhen.cn
1. 對不同級別的代碼進行注釋
對于不同級別的代碼塊,要使用統(tǒng)一的方法來進行注釋。例如:
對于每一個類,需要包含一段簡明扼要的描述,作者和上一次修改的時間
對于每一個方法,需要包含這個方法的用途,功能,參數(shù)以及返回結(jié)果
當(dāng)你在一個團隊里面的時候,采用一套注釋的標(biāo)準(zhǔn)是非常重要的。當(dāng)然,使用一種大家都認(rèn)可的注釋約定和工具(例如C#的XML注釋和Java的Javadoc)在一定程度上能推動這項任務(wù)。
2. 使用段落注釋
首先把代碼塊分解成多個“段落”,每一個段落都執(zhí)行單一的任務(wù);然后在每一個“段落”開始之前添加注釋,告訴閱讀代碼的人接下來的這段代碼是干什么用的
3. 對齊注釋行
對于那些在行末寫有注釋的代碼,應(yīng)該對齊注釋行來使得方便閱讀
有些開發(fā)人員使用tab來對齊注釋,而另外一些人會用空格來對齊。由于tab在不同的編輯器和集成開發(fā)環(huán)境中會有所不同,所以最佳的方法是使用空格來對齊注釋行。
4. 不要侮辱閱讀者的智慧
要避免沒用的注釋,例如
這不單把時間浪費在寫沒用的注釋上面,同時也在分散讀者的注意力。
5. 要有禮貌
應(yīng)當(dāng)避免沒有禮貌的注釋,例如“要注意一些愚蠢的用戶會輸入一個負(fù)數(shù)”,或者“修正由菜鳥工程師寫的愚蠢得可憐的代碼而導(dǎo)致的副作用”。這樣的注釋對于代碼的寫注釋的人來說并沒有任何好處,同時你永遠(yuǎn)都不會知道將來這些注釋會被誰來閱讀,你的老板,一個客戶或者是剛才被你數(shù)落的愚蠢得可憐的工程師。
6. 直截了當(dāng)
不要在注釋里面寫過多的廢話。避免在注釋里面賣弄ASCII藝術(shù),寫笑話,作詩和過于冗長。簡而言之就是保持注釋的簡單和直接。
7. 使用統(tǒng)一的風(fēng)格
有些人覺得注釋應(yīng)該讓非程序員也能看懂。另外一些人覺得注釋需要面對的讀者只是程序員。無論如何,正如Successful Strategies for Commenting Code中所說的,最重要的是注釋的風(fēng)格需要統(tǒng)一,并且總是面向相同的讀者。就自己而論,我懷疑非程序員是否會去讀代碼,所以我覺得注釋應(yīng)該面向程序員來寫。
網(wǎng)站建設(shè)的公司形形色色,有些報價很高的公司自稱是高端網(wǎng)站建設(shè),有些做網(wǎng)站的公司報價卻相對較低。難道高端與普通,只能通過報價來確定嗎?讀完這篇文章,讓你識破“偽高端”網(wǎng)站制作公司,少花冤枉錢!真正高端的網(wǎng)站建設(shè)公司,在以下幾點上和普通的網(wǎng)站制作公司有著顯著差異。
一、不同的存儲空間
空間是企業(yè)網(wǎng)站建設(shè)時必須購買的,普通的網(wǎng)站建設(shè)和高端的網(wǎng)站建設(shè)公司所購買的空間的質(zhì)量是不一樣的。相對來說,高端網(wǎng)站建設(shè)會選購大品牌的空間,雖然價格更高,但是空間存儲質(zhì)量更高,企業(yè)網(wǎng)站的數(shù)據(jù)更安全。
二、不同的網(wǎng)站建設(shè)規(guī)劃
企業(yè)網(wǎng)站建設(shè)規(guī)劃是網(wǎng)站建設(shè)的重要前置條件。普通的網(wǎng)站建設(shè)通常只會簡單傾聽企業(yè)客戶的需求;而高端的網(wǎng)站建設(shè)則會從整體著手,用科學(xué)的市場調(diào)研來指導(dǎo)企業(yè)網(wǎng)站建設(shè)的策劃。因此,高端的網(wǎng)站建設(shè)在規(guī)劃階段的耗時可能更長,但是做出來的網(wǎng)站效果也更好。
三、不同的網(wǎng)站開發(fā)框架
網(wǎng)站開發(fā)框架的選擇決定了企業(yè)網(wǎng)站質(zhì)量的好壞。普通的網(wǎng)站建設(shè)為了省事、省成本,會直接套用模板框架。這樣做網(wǎng)站雖然交付快,但是網(wǎng)站效果不佳。而高端的網(wǎng)站制作公司則會根據(jù)企業(yè)的需求搭建網(wǎng)站開發(fā)框架,雖然成本稍高,但是實現(xiàn)的效果更佳。
四、不同的網(wǎng)站優(yōu)化推廣服務(wù)
高端網(wǎng)站建設(shè)由于在規(guī)劃階段和網(wǎng)站開發(fā)框架的選擇上都比普通網(wǎng)站建設(shè)更好,因此在網(wǎng)站后期優(yōu)化上,高端網(wǎng)站建設(shè)也會更省事、更省時。
本文由上海緣震網(wǎng)絡(luò)科技有限公司(http://www.9youmishi.cn/)原創(chuàng)編輯,轉(zhuǎn)載請注明!
網(wǎng)站制作 網(wǎng)站建設(shè) 網(wǎng)站建設(shè)公司 網(wǎng)站開發(fā) 網(wǎng)站設(shè)計 網(wǎng)站開發(fā)公司 企業(yè)網(wǎng)站建設(shè) 上海網(wǎng)站建設(shè) 上海網(wǎng)站制作 上海網(wǎng)站開發(fā) 小程序開發(fā) 公眾號代運營 公眾號推廣
? ? ? ? | 公司名稱:上海緣震網(wǎng)絡(luò)科技有限公司 開戶銀行:中國工商銀行上海市彭浦支行 銀行賬號:1001 2508 0930 0206 455 |
總部:上海市奉賢區(qū)金海公路6055號29號3樓 分部:上海市靜安區(qū)共和新路4718弄10號樓2樓 商務(wù)官網(wǎng):www.9youmishi.cn 新官網(wǎng):www.shyuanzhen.com 彥蓁科技:www.shyanzhen.cn | 緣震網(wǎng)絡(luò)成立于 2014 年,公司主要經(jīng)營全案策劃,高端品質(zhì)網(wǎng)站建設(shè)、多媒體視頻宣傳片制作、微信公眾號開發(fā)、微信小程序開發(fā)、商城定制、SEO優(yōu)化、電商托管、空間托管、網(wǎng)站維護、應(yīng)用軟件開發(fā)、手機端APP開發(fā)、等為客戶提供一條龍網(wǎng)絡(luò)運營解決方案的的技術(shù)型企業(yè)。我們在人力資源、業(yè)務(wù)范圍、設(shè)計、技術(shù)、服務(wù)、信譽度、規(guī)范管理及企業(yè)文化等諸多方面完善自己,公司目前已與千余家各類客戶進行長期戰(zhàn)略合作,提供專業(yè)的網(wǎng)站建設(shè)與運營服務(wù)。我們的口號:廣結(jié)良緣、震古爍今! |