




版權(quán)說明:本文檔由用戶提供并上傳,收益歸屬內(nèi)容提供方,若內(nèi)容存在侵權(quán),請進(jìn)行舉報或認(rèn)領(lǐng)
文檔簡介
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.
約定,規(guī)范function
n.
函數(shù)trailing
adj.
拖尾的ruleofthumb
經(jīng)驗法則potential
adj.
可能的,潛在的prefix
n.
前綴illustrate
vt.
說明,闡明concatenate
vt.
連接,并置routine
n.
例程,例行程序procedure
n.
過程,程序GLOSSARYWords&expressions6.3Sourcecodedocumentation…cohesion
n.
內(nèi)聚度imply
vt.
暗示,意味precisely
iii
adv.
精確地,明確地wishy-washy
iii
adj.
乏味的elastic
ii
adj.
靈活的stretch
vt.
延伸,擴(kuò)展generic
adj.
一般的,通用的overwhelm
vt.
淹沒,壓倒delimit
vt.
定界限,限定perspective
n.
觀點,看法GLOSSARYWords&expressions6.3Sourcecodedocumentation…readily
adv.
容易地non-trivial
adj.
重要的duplicate
vt.
復(fù)制,重復(fù)redundant
adj.
冗余的evolve
vi.
發(fā)展asterisk
n.
星號,星標(biāo)indent
vt.
縮進(jìn)precede
vt.
先于,在…之前apart
adv.
分開,離開differ
vi.
相異,不同GLOSSARYWords&expressions6.3Sourcecodedocumentation…shift
vt.
移位chunk
n.
塊,程序塊delimiter
n.
定界符,分隔符consecutive
adj.
連續(xù)的adequate
adj.
適當(dāng)?shù)模銐虻膁estination
n.
目的,目標(biāo)deliberate
adj.
謹(jǐn)慎的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.
一個好的例程名能明確地描述該例程的功能。
注意頭文件的命名以避免模塊間潛在的沖突。在可應(yīng)用的時候,所有源文檔的格式應(yīng)適當(dāng)?shù)嘏c原始程序語言定義的通用格式兼容。塊注釋用來說明文件、方法、數(shù)據(jù)結(jié)構(gòu)和算法。
6.3Sourcecodedocumentation…e) Shortcommentscanappearonasinglelineindentedtothelevelofthecodethatfollows.
f) Veryshortcommentscanappearonthesamelineasthecodetheydescribe,butshouldbeshiftedfarenoughtoseparatethemfromthestatements.g) Theinformationprovidedbydocumentationcommentsdeliversveryimportantmessagestootherdevelopersandusers.h) Documentationcomments,speciallyinJava,describetheclasses,interfaces,constructors,methods,andfields.
短注釋可以出現(xiàn)在單一一行,縮進(jìn)位置與其后的代碼相同。若注釋非常短,可與代碼同行,但要空出足夠的間距。
文檔注釋向其他開發(fā)人員和用戶傳遞非常重要的信息。文檔注釋,特別是在Java語言中,說明類、接口、構(gòu)造函數(shù)、成員方法和成員變量。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. 本站的文檔不包含任何第三方提供的附件圖紙等,如果需要附件,請聯(lián)系上傳者。文件的所有權(quán)益歸上傳用戶所有。
- 3. 本站RAR壓縮包中若帶圖紙,網(wǎng)頁內(nèi)容里面會有圖紙預(yù)覽,若沒有圖紙預(yù)覽就沒有圖紙。
- 4. 未經(jīng)權(quán)益所有人同意不得將文件中的內(nèi)容挪作商業(yè)或盈利用途。
- 5. 人人文庫網(wǎng)僅提供信息存儲空間,僅對用戶上傳內(nèi)容的表現(xiàn)方式做保護(hù)處理,對用戶上傳分享的文檔內(nèi)容本身不做任何修改或編輯,并不能對任何下載內(nèi)容負(fù)責(zé)。
- 6. 下載文件中如有侵權(quán)或不適當(dāng)內(nèi)容,請與我們聯(lián)系,我們立即糾正。
- 7. 本站不保證下載資源的準(zhǔn)確性、安全性和完整性, 同時也不承擔(dān)用戶因使用這些下載資源對自己和他人造成任何形式的傷害或損失。
最新文檔
- 豬場生物安全工作述職報告
- 動漫游戲創(chuàng)新創(chuàng)業(yè)
- 自閉癥療愈師培訓(xùn)
- 節(jié)前保密教育培訓(xùn)
- 倉儲部經(jīng)理個人述職報告
- 2025年一建《機(jī)電工程管理與實務(wù)》考試核心基礎(chǔ)知識點精講試卷
- 定制家具年度工作總結(jié)
- 2025年消防安全應(yīng)急處置實操技能考試試題集
- 2025年游泳教練資格認(rèn)證考試游泳教練綜合素質(zhì)評價試題試卷
- 2025年大學(xué)統(tǒng)計學(xué)期末考試題庫:多元統(tǒng)計分析機(jī)器學(xué)習(xí)與應(yīng)用試題
- 幼兒園10以內(nèi)的加減法課件
- 益生菌精品課件
- 超聲科質(zhì)量控制內(nèi)容與標(biāo)準(zhǔn)完整
- 研究思路圖模板
- 耳鼻咽喉頭頸外科學(xué)第篇 鼻科學(xué)
- 安徽省環(huán)境監(jiān)測收費標(biāo)準(zhǔn)
- 沃爾瑪全國的分布
- 電子營業(yè)執(zhí)照下載確認(rèn)書(外籍法定代表人)
- 鋼結(jié)構(gòu)廠房工程施工組織設(shè)計方案(85頁)
- T∕CGCC 17-2018 商業(yè)信譽評價體系
- 數(shù)獨6×6初級打印版
評論
0/150
提交評論