版权说明:本文档由用户提供并上传,收益归属内容提供方,若内容存在侵权,请进行举报或认领
文档简介
UnitSixDocumentingYourWorkContentsPersuadingothers
Listening&speakingCommentingsourcecodesproperly
Technical
conversationsSourcecodedocumentationconventions
ReadingE-mail&technicalwriting
WritingObjectivesThisunitwillteachyou–
Toshowagreementanddisagreement; Tolearntopersuadeothers; Tocommentsourcecodesproperly; Toreadandwritesourcecodedocumentation; To
replyandforwarde-mails; Tolearnhowtodraftplanningproposals.6.1PersuadingothersA.Culturetips Listentotheaudioandanswerthesequestions:Whenyouwanttointerruptsomeone,thebesttimeis_____. A.inthemiddleofasentence B.afterhe/shefinisheshis/herspeech C.betweensentencesCWhichofthefollowingisthemosteffectivewaytoconveyyourmeaning?______
A.words B.intonation C.bodylanguageOccasionaldifferencesofopinionsbetweenabossandasubordinateareasignof________inAmericancompanies. A.agoodworkingrelationship B.anintenserelationship C.abadrelationship6.1PersuadingothersCAB.Groupdiscussions:persuadingothers1. Readthetwodialogsbetweenco-workersandtellwhichoneisbetter,theleftortheright.2. Listentotheconversation,theprojectteamisdiscussinghiringnewprogrammers.6.1Persuadingothers6.1PersuadingothersB.Groupdiscussions:persuadingothersSentencepatterns
LearntousetheseexpressionstoStronglyagree;Agree;Partlyagree;Disagree;Stronglydisagree;Interrupt.6.1PersuadingothersC.ExercisesDictation1.SomeTipsforPersuadingOthers1.
admittoaminorweakness2.
statingthestrengths
3.Icanbetrusted
4.actsagainsttheirownself-interest
5.buildcredibility
6.theopinionofothers
7.Forinstance
8.
ontheotherhand
9.
makingapositivestatement
10.
morecredible
11.
Themoresimilar
12.
themorepowerful
13.
makeinformeddecisions
6.1PersuadingothersC.ExercisesDictation2.Conversationbetweencolleagues1.
efficientandreliable
2.
Ifeelsure
3.
Iagreewithyou
4.
ontheotherhand
5.
asksfor6.
chargesfarless
7.
you’vegotapoint
8.
accordingto6.1PersuadingothersOralpracticeYOUMr.JohnsonShowyourunderstanding.Idon’tthinkwecanmoveintotheJapanesemarketatthistime.We’dbetterimproveandincreaseourshareofthemarkethereinChina.Trytointerrupt.ThepotentialmarketinJapanisnodoubthuge,but…Showagreement.JustletmefinishwhatIwassaying,please.Showyourunderstanding.…but,beforewemoveintotheJapanesemarketweshouldstrengthenourmarketsharehereinChina.Whatwereyoutryingtosayjustnow?IbelieveoursuccessinChinacanbringusamuchmorereliablereputationthanjustsettingupbranchesinJapan.Whatdoyouthink?Doyouagreewithme?Iwastryingtoremindyouthatourrival,AAACompany,hasalreadysetupseveralbranchesinJapan.Ithasalreadybeguntoestablishitsreputationthere.Completelydisagree,insistonmovingintoJapanesemarketnow.
A.DiscussingcodedocumentingconventionsAnnieJefferson,SamCarter,andMichaelZhangarereceivingatrainingprogramofferedbytheR&DDepartment. that’saboutall… jotdown…Languagepoints: make…clear stickto getreadyforTechnicalterms: codedocumentation
6.2Commentingsourcecodes…
B.RefiningsubstandardsourcecodesJackyisassemblingagroupdiscussionwithSamandAnnieabouttheircodecomments. getdowntobusiness I’msorrytosay…Languagepoints: breakoldhabits thereisaproblemwith… itwouldbemuchbetterif…Technicalterms: sourcedocumentation
6.2Commentingsourcecodes…C.Fillintheblanks
1.Fillintheblanksinthefollowingsentenceswiththegivenexpressions.a) –Iguessanewyearisagoodtimefor__________________. Weshouldstarttomakethenewdevelopmentregulations workfromnowon. –Thatsoundsgreat,butareyousureyourguyshave_____ theregulations______enoughtoputintoeffect?b) –____________________thesyntaxintheselines.Have youcheckedthecodeyourself? –Ah,Iamterriblysorry,pleaseletme_________these lines,andI’llgetaroundtothemassoonaspossible.breakingoldhabitsmadeclearThereisaproblemwithjotdown6.2Commentingsourcecodes…c) –Well,Iassume_______________________classnames, variables,andcommentswereinboldorinadifferentcolor. –Thanksforyouradvice,butI’dbetter_______the conventionssetbymycompany.d) –OK,everyone._______________forthissessionofour meeting.Inthenextsession,we’llhavegroupdiscussions aboutwhatwe’velearnttoday. –______________thatIamstillconfusedaboutonething: whycan’twecapitalizethefirstwordinafunctionname?e) –Thegoodnewsis,withthenewplatform,programmerswill ___________________fasterwithhundredsofcompatible productsandintegratedsolutions. –Maybe,theyjusthavetospendalotoftimeto ____________thisnewchange.itwouldbemuchbetterifsticktoThat’saboutallI’msorrytosaygetreadyforgetdowntobusiness6.2Commentingsourcecodes…a) Youareconcludingapresentationaboutyourworkinthepreviousmonth. ________________________________________________________________________________________________________b) Acolleagueaskedwhattoincludeinthecopyrightcomment.Youarenotverysure.________________________________________________________________________________________________________Sothat’saboutalloftheprogressreportformyworkoverthelastmonth.I’mafraidI’mnotreallysureaboutthecontentinthecopyrightcomment.
6.2Commentingsourcecodes…C.Fillintheblanks
1.Supposeyouareinthefollowingsituations.Whatshouldyousay?
c) Yourgrouphasalotofcontroversyaboutanunsettledissue.Yousuggestdiscussingitlater. ___________________________________________________d) Acolleaguepointedoutthatyoualwaysstartanewlineforthecomments.Youdon’tunderstandwhat’swrongwiththat.
___________________________________________________
e) Youareremindingalltheteammemberstocitesourcesforalltheborrowedcodes. ___________________________________________________ ___________________________________________________
Let’sjustputitasidefornow.Isthereaproblemwiththat?Youmustremembertodocumentthesourcealongwiththecodeyouborrow.6.2Commentingsourcecodes…D.Workinpairs Imagineyouandyourpartnerareinagroupdiscussion.Sittogether,andmakeupconversationsaccordingtothefollowinginformation.Taketurnsplayingdifferentroles.6.2Commentingsourcecodes…E.Groupwork
1.Formgroupsofthreetofourpeople,andholdagroupdiscussionaccordingtothefollowinginformation.Changetheroleswhenyou’vedonewithoneversion.Remembertovaryyourlanguagewithyourcreativity.6.2Commentingsourcecodes… 2.Formagroupwithothermembersofyourclass.Locateapieceofsourcecodedevelopedbyanyoneofyou,andinitiateagroupdiscussionabouthowtomakeitmorereadableandstandard.Moreimportantly,trytoadaptthecodewiththemethodsyouagreedon.6.2Commentingsourcecodes…A.Anoverview
Readtheoverviewandanswerthesequestions:Whatissoftwaredocumentationusedfor?Whoisresponsibleforcreatingsoftwaredocumentation?Howissoftwaredocumentationcreated?6.3Sourcecodedocumentation…B.Anamingandcodedocumentationguide Beforeyouscanthewholedocument,keepthesequestionsinmind:Whatisthisdocumentmainlytalkingabout?Whereshallwegoifwewanttoknowaboutimplementationcomments?Whenshouldweuseblockcommentsincodedocumentation?Howmanytypesofdocumentationcommentsareincludedinthisarticle?6.3Sourcecodedocumentation…6.3Sourcecodedocumentation…convention
n.
约定,规范function
n.
函数trailing
adj.
拖尾的ruleofthumb
经验法则potential
adj.
可能的,潜在的prefix
n.
前缀illustrate
vt.
说明,阐明concatenate
vt.
连接,并置routine
n.
例程,例行程序procedure
n.
过程,程序GLOSSARYWords&expressions6.3Sourcecodedocumentation…cohesion
n.
内聚度imply
vt.
暗示,意味precisely
iii
adv.
精确地,明确地wishy-washy
iii
adj.
乏味的elastic
ii
adj.
灵活的stretch
vt.
延伸,扩展generic
adj.
一般的,通用的overwhelm
vt.
淹没,压倒delimit
vt.
定界限,限定perspective
n.
观点,看法GLOSSARYWords&expressions6.3Sourcecodedocumentation…readily
adv.
容易地non-trivial
adj.
重要的duplicate
vt.
复制,重复redundant
adj.
冗余的evolve
vi.
发展asterisk
n.
星号,星标indent
vt.
缩进precede
vt.
先于,在…之前apart
adv.
分开,离开differ
vi.
相异,不同GLOSSARYWords&expressions6.3Sourcecodedocumentation…shift
vt.
移位chunk
n.
块,程序块delimiter
n.
定界符,分隔符consecutive
adj.
连续的adequate
adj.
适当的,足够的destination
n.
目的,目标deliberate
adj.
谨慎的align
vt.
校直,使对齐GLOSSARYWords&expressionsC.Post-readingexercisesHowmanystylesofimplementationcommentsarementionedhere?Whatarethey?BlockComments;Single-LineComments;TrailingComments;OutComments.6.3Sourcecodedocumentation…Pleaseconnectthefollowingnameswiththeirmainconventions.thefirstletterofallwordscapitalizedVariablesClassfilesandheaderfilesFunctionsClassesthefirstletterofallwordscapitalizedexceptforthefirstonereflectsthecontentofthefilemorethaneightcharacterswithamixofuppercasesandlowercases6.3Sourcecodedocumentation…ExtensionDescription.C.CPP.H.INL.IDL(.ODL).RC.JavaCsourcefileC/C++headerfileC++inlinefunctionfileInterfaceDescriptionlanguageResourceScriptJavasourcefileC++sourcefile6.3Sourcecodedocumentation…Fillinthefollowingtable.4. Translations.a) Agoodnameforaroutineclearlydescribeseverythingtheroutinedoes.
b) Specialcareshouldbegiventothenamingofheaderfilesbecauseofpotentialconflictsbetweenmodules.
c) Whenapplicable,allsourcedocumentationshouldbeinaformatcompatiblewiththegenericformattingdefinedbytheoriginalprogramminglanguage.
d) Blockcommentsareusedtoprovidedescriptionsoffiles,methods,datastructuresandalgorithms.
一个好的例程名能明确地描述该例程的功能。
注意头文件的命名以避免模块间潜在的冲突。在可应用的时候,所有源文档的格式应适当地与原始程序语言定义的通用格式兼容。块注释用来说明文件、方法、数据结构和算法。
6.3Sourcecodedocumentation…e) Shortcommentscanappearonasinglelineindentedtothelevelofthecodethatfollows.
f) Veryshortcommentscanappearonthesamelineasthecodetheydescribe,butshouldbeshiftedfarenoughtoseparatethemfromthestatements.g) Theinformationprovidedbydocumentationcommentsdeliversveryimportantmessagestootherdevelopersandusers.h) Documentationcomments,speciallyinJava,describetheclasses,interfaces,constructors,methods,andfields.
短注释可以出现在单一一行,缩进位置与其后的代码相同。若注释非常短,可与代码同行,但要空出足够的间距。
文档注释向其他开发人员和用户传递非常重要的信息。文档注释,特别是在Java语言中,说明类、接口、构造函数、成员方法和成员变量。6.3Sourcecodedocumentation…Thefivetypesofdocumentationcomments,asmentionedinthearticle,arelistedbelow.Trytouseasfewwordsaspossibletodescribethem.Copyrightinformation:
Modulecomments:Revisionhistory:Codespecification:Sourcedocumentation:providesthecopyrightandlicensinginformationofthecode.6.3Sourcecodedocumentation…indicateswherethereadercanfindthesourcesoftheinformation.containsenoughinformationabouttheprogrammer’sdestination.recordsthehistoryofchangesinthesourcefiles.describestheclasses,interfaces,constructors,methods,andfields.6.4E-mail&technicalwritingA.Replyingorforwardinge-mailsproperly
Keypoints:Everymessageotherthanspamorjunkmaildeservesareply.Giveyourfinalanswerinyourreply.Respondassoonaspossible.Whenreplying,includeenoughoftheoriginalmessagetoprovideacontext.Whenreplyingorforwardingamessage,minimizetheoriginalone.Distinguishbetweentextquotedfromtheoriginalmessageandyourreply.Knowwhereyourreplyorforwardwillendup.6.4E-mail&technicalwritingA.Replyingorforwardinge-mailsproperly Keypoints:Replytoe-mailswithone-wordanswersorquestions.Forwarde-mailsunlessyouhavethepermissionoftheauthor.Forwardforwardedmessagestoyourfriendsandco-workers.Use“ReplyToAll”whenyouarereplyingtojustonesender.B.E-mailsaboutsoftwaredocumentation
Assignments:Gatherexamplesofe-mailrepliesandforwardede-mails.Aretheyproperlywrittenintermsoflayout,tone,andprofessionalism?Writealettertoacolleagueaboutcopyrightcomments.6.4E-mail&technical
温馨提示
- 1. 本站所有资源如无特殊说明,都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
- 2. 本站的文档不包含任何第三方提供的附件图纸等,如果需要附件,请联系上传者。文件的所有权益归上传用户所有。
- 3. 本站RAR压缩包中若带图纸,网页内容里面会有图纸预览,若没有图纸预览就没有图纸。
- 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
- 5. 人人文库网仅提供信息存储空间,仅对用户上传内容的表现方式做保护处理,对用户上传分享的文档内容本身不做任何修改或编辑,并不能对任何下载内容负责。
- 6. 下载文件中如有侵权或不适当内容,请与我们联系,我们立即纠正。
- 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。
最新文档
- 二零二五年度智能家居音响系统与家装室内装修合同9篇
- 二零二五版大理石瓷砖研发与销售合作合同范本3篇
- 二零二五版民营企业股权激励合同书3篇
- 教育局教师幼儿园专项2025年度劳动合同规范文本3篇
- 二零二五年销售代理合同:汽车销售代理及区域独家合作协议2篇
- 2025年科技孵化器场地租赁保证金合同范本2篇
- 二零二五版39上公司兜底协议:绿色环保项目投资风险控制合同3篇
- 二零二五年度钢箱梁桥工程施工废弃物处理与回收利用合同3篇
- 二零二五版绿色建筑项目基础劳务分包合同2篇
- 二零二五年度高速公路隧道防雷安全防护合同3篇
- Android移动开发基础案例教程(第2版)完整全套教学课件
- 医保DRGDIP付费基础知识医院内培训课件
- 专题12 工艺流程综合题- 三年(2022-2024)高考化学真题分类汇编(全国版)
- DB32T-经成人中心静脉通路装置采血技术规范
- 【高空抛物侵权责任规定存在的问题及优化建议7100字(论文)】
- TDALN 033-2024 学生饮用奶安全规范入校管理标准
- 物流无人机垂直起降场选址与建设规范
- 冷库存储合同协议书范本
- AQ/T 4131-2023 烟花爆竹重大危险源辨识(正式版)
- 武术体育运动文案范文
- 设计服务合同范本百度网盘
评论
0/150
提交评论