已阅读5页,还剩37页未读, 继续免费阅读
版权说明:本文档由用户提供并上传,收益归属内容提供方,若内容存在侵权,请进行举报或认领
文档简介
UnitSixDocumentingYourWork Contents PersuadingothersListening speakingCommentingsourcecodesproperlyTechnicalconversationsSourcecodedocumentationconventionsReadingE mail technicalwritingWriting Objectives Thisunitwillteachyou Toshowagreementanddisagreement Tolearntopersuadeothers Tocommentsourcecodesproperly Toreadandwritesourcecodedocumentation Toreplyandforwarde mails Tolearnhowtodraftplanningproposals 6 1Persuadingothers A CulturetipsListentotheaudioandanswerthesequestions Whenyouwanttointerruptsomeone thebesttimeis A inthemiddleofasentenceB afterhe shefinisheshis herspeechC betweensentences C Whichofthefollowingisthemosteffectivewaytoconveyyourmeaning A wordsB intonationC bodylanguageOccasionaldifferencesofopinionsbetweenabossandasubordinateareasignof inAmericancompanies A agoodworkingrelationshipB anintenserelationshipC abadrelationship 6 1Persuadingothers C A B Groupdiscussions persuadingothers1 Readthetwodialogsbetweenco workersandtellwhichoneisbetter theleftortheright 2 Listentotheconversation theprojectteamisdiscussinghiringnewprogrammers 6 1Persuadingothers 6 1Persuadingothers B Groupdiscussions persuadingothersSentencepatternsLearntousetheseexpressionstoStronglyagree Agree Partlyagree Disagree Stronglydisagree Interrupt 6 1Persuadingothers C ExercisesDictation1 SomeTipsforPersuadingOthers 1 admittoaminorweakness2 statingthestrengths3 Icanbetrusted4 actsagainsttheirownself interest5 buildcredibility6 theopinionofothers7 Forinstance 8 ontheotherhand9 makingapositivestatement10 morecredible11 Themoresimilar12 themorepowerful13 makeinformeddecisions 6 1Persuadingothers C ExercisesDictation2 Conversationbetweencolleagues 1 efficientandreliable2 Ifeelsure3 Iagreewithyou4 ontheotherhand 5 asksfor6 chargesfarless7 you vegotapoint8 accordingto 6 1Persuadingothers Oralpractice YOU Mr Johnson Showyourunderstanding 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 clearsticktogetreadyforTechnicalterms codedocumentation 6 2Commentingsourcecodes B RefiningsubstandardsourcecodesJackyisassemblingagroupdiscussionwithSamandAnnieabouttheircodecomments getdowntobusinessI msorrytosay Languagepoints breakoldhabitsthereisaproblemwith itwouldbemuchbetterif Technicalterms sourcedocumentation 6 2Commentingsourcecodes C Fillintheblanks1 Fillintheblanksinthefollowingsentenceswiththegivenexpressions a Iguessanewyearisagoodtimefor Weshouldstarttomakethenewdevelopmentregulationsworkfromnowon Thatsoundsgreat butareyousureyourguyshave theregulations enoughtoputintoeffect b thesyntaxintheselines Haveyoucheckedthecodeyourself Ah Iamterriblysorry pleaseletme theselines andI llgetaroundtothemassoonaspossible breakingoldhabits made clear Thereisaproblemwith jotdown 6 2Commentingsourcecodes c Well Iassume classnames variables andcommentswereinboldorinadifferentcolor Thanksforyouradvice butI dbetter theconventionssetbymycompany d OK everyone forthissessionofourmeeting Inthenextsession we llhavegroupdiscussionsaboutwhatwe velearnttoday thatIamstillconfusedaboutonething whycan twecapitalizethefirstwordinafunctionname e Thegoodnewsis withthenewplatform programmerswill fasterwithhundredsofcompatibleproductsandintegratedsolutions Maybe theyjusthavetospendalotoftimeto thisnewchange itwouldbemuchbetterif stickto That saboutall I msorrytosay getreadyfor getdowntobusiness 6 2Commentingsourcecodes a Youareconcludingapresentationaboutyourworkinthepreviousmonth b Acolleagueaskedwhattoincludeinthecopyrightcomment Youarenotverysure Sothat saboutalloftheprogressreportformyworkoverthelastmonth I mafraidI mnotreallysureaboutthecontentinthecopyrightcomment 6 2Commentingsourcecodes C Fillintheblanks1 Supposeyouareinthefollowingsituations Whatshouldyousay c Yourgrouphasalotofcontroversyaboutanunsettledissue Yousuggestdiscussingitlater d Acolleaguepointedoutthatyoualwaysstartanewlineforthecomments Youdon tunderstandwhat swrongwiththat e Youareremindingalltheteammemberstocitesourcesforalltheborrowedcodes Let sjustputitasidefornow Isthereaproblemwiththat Youmustremembertodocumentthesourcealongwiththecodeyouborrow 6 2Commentingsourcecodes D WorkinpairsImagineyouandyourpartnerareinagroupdiscussion Sittogether andmakeupconversationsaccordingtothefollowinginformation Taketurnsplayingdifferentroles 6 2Commentingsourcecodes E Groupwork1 Formgroupsofthreetofourpeople andholdagroupdiscussionaccordingtothefollowinginformation Changetheroleswhenyou vedonewithoneversion Remembertovaryyourlanguagewithyourcreativity 6 2Commentingsourcecodes 2 Formagroupwithothermembersofyourclass Locateapieceofsourcecodedevelopedbyanyoneofyou andinitiateagroupdiscussionabouthowtomakeitmorereadableandstandard Moreimportantly trytoadaptthecodewiththemethodsyouagreedon 6 2Commentingsourcecodes ExampleofComments ExampleofComments cont A AnoverviewReadtheoverviewandanswerthesequestions Whatissoftwaredocumentationusedfor Whoisresponsibleforcreatingsoftwaredocumentation Howissoftwaredocumentationcreated 6 3Sourcecodedocumentation B AnamingandcodedocumentationguideBeforeyouscanthewholedocument keepthesequestionsinmind Whatisthisdocumentmainlytalkingabout Whereshallwegoifwewanttoknowaboutimplementationcomments Whenshouldweuseblockcommentsincodedocumentation Howmanytypesofdocumentationcommentsareincludedinthisarticle 6 3Sourcecodedocumentation 6 3Sourcecodedocumentation GLOSSARY Words expressions 6 3Sourcecodedocumentation GLOSSARY Words expressions 6 3Sourcecodedocumentation GLOSSARY Words expressions 6 3Sourcecodedocumentation GLOSSARY Words expressions C Post readingexercisesHowmanystylesofimplementationcommentsarementionedhere Whatarethey BlockComments Single LineComments TrailingComments OutComments 6 3Sourcecodedocumentation Pleaseconnectthefollowingnameswiththeirmainconventions thefirstletterofallwordscapitalized Variables Classfilesandheaderfiles Functions Classes thefirstletterofallwordscapitalizedexceptforthefirstone reflectsthecontentofthefile morethaneightcharacterswithamixofuppercasesandlowercases 6 3Sourcecodedocumentation Csourcefile C C headerfile C inlinefunctionfile InterfaceDescriptionlanguage ResourceScript Javasourcefile C sourcefile 6 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 technicalwriting A Replyingorforwardinge mailsproperlyKeypoints Everymessageotherthanspamorjunkmaildeservesareply Giveyourfinalanswerinyourreply Respondassoonaspossible Whenreplying includeenoughoftheoriginalmessagetoprovideacontext Whenreplyingorforwardingamessage minimizetheoriginalone Distinguishbetweentextquotedfromtheoriginalmessageandyourreply Knowwhereyourreplyorforwardwillendup 6 4E mail technicalwriting A Replyingorforwardinge mailsproperlyKeypoints Replytoe mailswithone wordanswersorquestions Forwarde mailsunlessyouhavethepermissionoftheauthor Forwardforwardedmessagestoyourfriendsandco workers Use ReplyToAll whenyouarereplyingtojustonesender B E mailsaboutsoftwaredocumentationAssignments Gatherexamplesofe mailrepliesandforwardede mails Aretheyproperlywrittenintermsoflayout tone andprofessionalism Writealettertoacolleagueaboutcopyrightcomments 6 4E mail technicalwriting C GuidetotechnicalwritingDraftingplanningproposals Useappropriateformatandsupplements Writeaconcreteandspecifictitle B
温馨提示
- 1. 本站所有资源如无特殊说明,都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
- 2. 本站的文档不包含任何第三方提供的附件图纸等,如果需要附件,请联系上传者。文件的所有权益归上传用户所有。
- 3. 本站RAR压缩包中若带图纸,网页内容里面会有图纸预览,若没有图纸预览就没有图纸。
- 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
- 5. 人人文库网仅提供信息存储空间,仅对用户上传内容的表现方式做保护处理,对用户上传分享的文档内容本身不做任何修改或编辑,并不能对任何下载内容负责。
- 6. 下载文件中如有侵权或不适当内容,请与我们联系,我们立即纠正。
- 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。
最新文档
- 高中信息技术教学设计:数据驱动的研究性学习项目实践-以舟山海洋文化数字调研为例
- 初中九年级地理教学设计:区域自然地理环境整合与中考真题突破
- 七年级英语上册Unit 4规则话题教学设计:基于核心素养的语法语用整合
- 小学三年级美术教学设计《青花瓷语有深情》岭美版下册实践探究
- 高三年级地理中国地理核心考点专题教学设计
- 高中音乐艺术欣赏第三单元《音乐与舞蹈》第一课时教学设计
- 小学一年级美术教学设计-湘美版上册《猜猜我是谁》单元整体教学设计与实施策略
- 初中九年级数学教学设计:抛物线形实物与运动轨迹问题第三课时
- 七年级英语教学设计:Unit 1 Section A Grammar Focus be动词与人称代词
- 2026事业单位工勤技能-新疆-新疆护理员二级(技师)历年参考题库含答案详解
- 颂钵培训课件
- 学生的情感需求与教育心理学
- HG20634-2024钢制管法兰紧固件
- 2025年江西省抚州市南城县株良镇国民经济和社会发展第十五个五年规划
- 教师数字提升培训课件
- 室内设计毕业答辩汇报
- 铁道机车专业教学武汉铁路黄秀川60课件
- 《影像学检查与肺部疾病》课件
- 情境化教学模式构建-全面剖析
- 2024年福建省中考满分作文《看月与探月》4
- 临床成人失禁相关性皮炎的预防与护理团体标准解读
评论
0/150
提交评论