JAVA编程风格

JAVA编程风格

ID:41037242

大小:34.00 KB

页数:5页

时间:2019-08-14

JAVA编程风格_第1页
JAVA编程风格_第2页
JAVA编程风格_第3页
JAVA编程风格_第4页
JAVA编程风格_第5页
资源描述:

《JAVA编程风格》由会员上传分享,免费在线阅读,更多相关内容在工程资料-天天文库

1、TheDefinitiveCS106StyleGuideTableofContents:WhyShouldICareaboutStyle?GoodNamingCommentingDecompositionWhitespaceInstancevs.LocalVariablesElegantCodeStructureAlwaysUseConstants:GeneralandReusableMethods:ThereAreManyWaysToSolvetheSameProblem:ShortMethods:WhyShouldICare

2、aboutStyle?It'scommonwhenyou'rewritingcodetothinkit'sself-explanatory.However,foranyone(yourselfincluded)who'sseeingcodeeitherforthefirsttimeorforthefirsttimeinafewdays,thewaythecodeworksisn'talwaysimmediatelyobvious.Thereasongoodstyleisimportantisbecausewell-structu

3、red,easy-to-readcodeiseasiertomodify,easiertodebugandeasiertoworkwith.Thisissomethingthatwillsaveyouhoursofwork.Whenindoubtastowhetheryoushoulddosomethingforstylereasons("shouldIcommentthisline?"),justrememberthespiritofcodestyle:theobjectistomakeyourcodeasreadableas

4、possible.Herearesometipstomakeyourprogrammingstylebetterandthelifeofanyonereadingitmucheasier!GoodNamingUsemeaningfulnames,butdon'tgooverboard.Supposeyouhaveavariableinyourprogramthatholdsthenumberofhoursemployeesworkedinaweek:/*OK,butnotverydescriptive*/inthours=40;

5、/*muchmoredescriptive,butcumbersome*/inthoursTheWorkersWorkedInOneWeek=40;/*agoodcompromise*/inthoursPerWeek=40;Commonabbreviationsareoftenacceptableinvariablenames,likehrsPerWeek.Butdon'tgetcarriedaway;hrsPWksimplyisnotagoodname.Partofgoodstyleisgoodnaming.Youwantyo

6、urmethodnametosuccinctlydescribewhatitdoes.NevercallamethoddoStuff,giveitagoodspecificnamelikeisOdd.Beconsistentinhowyounameyourmethods.Inoursolutions,wewilluselowercamelcasenamingconventions.CommentingMakesuretocommenteverymethodyouwrite,anddescribewhatthemethoddoes

7、,andwhattheassumptionsarebeforeandafteritiscalled.Writeyourcommentssothatyourprogramcouldeasilybeunderstoodbyanotherperson.Ingeneral,remembertohaveonecommentdescribingtheentireprogram,thenafewlinesabovethefunctionheaderforeachfunctiondescribingthepurposeofthefunction

8、,plusanypre-conditionsorassumptionsofthefunctionandmaybesomelineselaboratingupontheparametersifnecessary.It'salsogoodtocommentwheny

当前文档最多预览五页,下载文档查看全文

此文档下载收益归作者所有

当前文档最多预览五页,下载文档查看全文
温馨提示:
1. 部分包含数学公式或PPT动画的文件,查看预览时可能会显示错乱或异常,文件下载后无此问题,请放心下载。
2. 本文档由用户上传,版权归属用户,天天文库负责整理代发布。如果您对本文档版权有争议请及时联系客服。
3. 下载前请仔细阅读文档内容,确认文档内容符合您的需求后进行下载,若出现内容与标题不符可向本站投诉处理。
4. 下载文档时可能由于网络波动等原因无法下载或下载错误,付费完成后未能成功下载的用户请联系客服处理。