注釋

注釋

注釋。是對書籍或文章的語彙、內容、背景、引文作介紹、評議的文字。為了保障原作者的著作權。為古書注釋開始於先秦時期。中國古代分得較細,分別稱之為注、釋、傳、箋、疏、章句等。包含的內容很廣。諸凡字詞音義、時間地點、人物事跡、典故出處、時代背景都是注釋對象。有腳註、篇末注、夾注等形式。古籍注釋列在正文之中,有雙行夾注和夾注。現代書籍注釋列於正文當頁之下,稱腳註,亦稱本面注;列於文章之後或列於書籍之後者稱篇末注。不管採用何種方式,全書注文的編排一般要求統一,以便於讀者查考。

基本信息

定義

注釋annotation,是指對已有作品中的詞語內容引文、出處等所作的說明,也就是一種講解。注釋一般是針對作品的疑難處來進行說明,目的在於能使人們更準確、更完整地理解作品。注釋需要注釋者去蒐集資料,進行考證、推敲、理解吃透原作品。

著作權

對於注釋部分,注者應當享有著作權。注釋他人作品,應當取得著作權人的同意,並且無許可權制他人對同一作品進行新的注釋。

概述

書籍或文章的語彙、內容背景、引文作介紹、評議的文字。中國古代分得較細,分別稱之為注、釋、傳、箋、疏、章句等。現在一般通稱注釋。包含的內容很廣。諸凡字詞音義、時間地點、人物事跡、典故出處、時代背景都是注釋對象。有腳註、篇末注、夾注等形式。古籍注釋列在正文之中,有雙行夾注和夾注。現代書籍注釋列於正文當頁之下,稱腳註,亦稱本面注;列於文章之後或列於書籍之後者稱篇末注。不管採用何種方式,全書注文的編排一般要求統一,以便於讀者查考。

PHP 注釋

注釋
php支持C,C++和UnixShell風格(Perl風格)的注釋。例如:
<?php
echo"Thisisatest";//Thisisaone-linec++stylecomment
/*Thisisamultilinecomment
yetanotherlineofcomment*/
echo"Thisisyetanothertest";
echo"OneFinalTest";#Thisisshell-stylestylecomment
?>單行注釋僅僅注釋到行末或者當前的php代碼塊,視乎哪個首先出現。這意味著在//?>之後的HTML代碼將被顯示出來:?>跳出了php模式並返回了HTML模式,//並不能影響到這一點。如果啟用了asp_tags配置選項,其行為和//%>相同。不過,</script>標記在單行注釋中不會跳出php模式。
<h1>Thisisan<?php#echo"simple";?>example.</h1>
<p>Theheaderabovewillsay'Thisisanexample'.C風格的注釋在碰到第一個*/時結束。小心不要嵌套C風格的注釋,當注釋大量代碼時,可能犯該錯誤。
<?php
/*
echo"Thisisatest";/*Thiscommentwillcauseaproblem*/
*/
?>

解釋

1.[note;footnote;annotation]解釋字句的文字。
(1)南朝梁劉勰《文心雕龍·論說》:“若夫注釋為詞,解散論體,雜文雖異,總會是同。”
(2)唐劉知幾《史通·補註》:“既而史傳小書,人物雜記……文言美辭,列於章句,委曲
敘事,存於細書。此之注釋,異夫儒士者矣。”
(3)《<廖仲愷集>前言》:“文中的外國地名、人名,與通用的譯名不一致,為保持原貌,未加改動,其中重要的作了簡略注釋。”
(4)宋嚴羽 《滄浪詩話·考證》:“舊蜀本杜詩,並無注釋。”
(5)田北湖《章源流》:“於一一音,有一一說,不達注釋,可以達用。”
(6)《瞿秋白文集輯委員會《<瞿秋白文集>序》:“在文集的各部分,編者都曾經加了一些注釋。”
2.[annotate;explainwithnotes]用文字解釋字句。
(1)《隋書·文學傳·潘徽》:“總會舊轍,創立新意,聲別相從,即隨注釋。”
(2)宋姚寬 《西溪叢語》卷下:“陶潛《海經》十三首用事,今本多差誤,各為注釋之。”
(3)明王鏊《長語·經傳》:“﹝朱子﹞天文歷律度數,無不究悉,仍好為文,工於詩,工於筆札,如《楚詞》、韓文,亦皆注釋。”
(4)《明史·顧鼎臣傳》:“進講范浚《心箴》,敷陳剴切。帝悅,乃自為注釋,而鼎臣特受眷。”
(5)清昭連《嘯亭雜錄·純廟博雅》:“每一詩出,令儒臣注釋,不得原委者,許歸家涉獵。”
軟道語錄
注釋
注釋是程式設計師給代碼添加的文字性說明,以提高代碼的可讀性。

類型

論文書籍中的注釋
中文注釋的格式
1、當文章引用或借用的資料所在的著作第一次出現於注釋中時,須將該書作者姓名、書名、出版地、出版者、出版年代及引用資料所在的頁碼一併注出。
(1)引用專著例:
李道揆:《美國政府和美國政治》,北京.中國社會科學出版社,1990年版,第72-74頁。
說明:(a)作者姓名後面用冒號;著作名用書名號標出,書名號後加逗號;出版地後用間隔號(中圓點);出版社名稱後加逗號;出版年代後加“版”字,再加逗號;頁碼後用句號。
(b)著作者如系二人,作者姓名之間用頓號分隔,如:xxx、xxx;如系二人以上,可寫出第一作者姓名,後面加“等”字省略其他作者,如:xxx等。
(c)著作名如有副標題,則在書名號內以破折號將標題與副標題隔開。
如:
陳寶森:《美國經濟與政府政策——從羅斯福到里根》,北京.世界知識出版社,1988年版,第124頁。(d)著作如系多卷本,須在書名號後面直接寫出引用資料所在的卷數,再加句號。如:徐民:《抗美援朝的歷史回顧》上卷,北京.中國廣播出版社,1990年版,第5頁。
(e)出版地應包括省、自治區及其下屬的市名,直轄市只注市名,如:
吉林延吉.延邊教育出版社;北京.國際文化出版公司。如出版社名稱本身已含其中某一級地名,則可不必在出版地中重複注出,如:南京江蘇人民出版社,不必注為江蘇南京.江蘇人民出版社;北京出版社,不必注為北京.北京出版社。
(2)引用譯著例:
J.布盧姆等:《美國的歷程》下冊第二分冊(楊國標、張儒林譯,黃席群校),北京.商務印書館,1988年版,第97頁。
說明:(a)作者姓名中除姓(familyname)外,名與中間名(firstname和middlename)均可用縮寫形式表示,如縮寫,須用英文縮寫符號(下圓點);如將姓名全部譯出,則須在姓名之間加中文間隔符號(中圓點)。
(b)書名號後或多卷本著作卷次、冊次後直接加圓括弧,括弧內註明中文譯、校者姓名。
(3)引用編著例:
楊生茂主編:《美國外交政策史,1775—1989》,北京.人民出版社,1991年版,第23頁。
韓鐵等:《戰後美國史,1945—1986》(劉緒貽、楊生茂主編),北京.人民出版社,1989年版,第56頁。
說明:(a)第一例適用於僅有編者的著作。在編者姓名後,根據該書提供的信息加入“編”或“主編”,再加冒號;其餘部分與著作類注釋格式同。
(b)第二例適用於既有編者,又有著者的著作。這類注釋與著作類注釋基本相同,但須在書名號後加圓括弧,括弧內註明編者姓名,再在括弧後加句號。
(4)引用文集或期刊、雜誌內文章例:
馬克思:《哥達綱領批判》,載《馬克思恩格斯選集》第三卷,北京.人民出版社,1972年版,第21頁。
弗.傑姆遜:《處於跨國資本主義時代中的第三世界文學》,載《新歷史主義與文學批評》(張京媛主編),北京大學出版社,1992年版,第251頁。
吳展:《試論核裁軍的幾個問題》,載《美國研究》1994年第3期,第43頁。
說明:(a)先注作者名和篇名,篇名用書名號標出,書名號後加逗號;再注出文集或期刊名,文集或期刊名亦用書名號標出,書名號前加“載”字,緊接文集或期刊書名號後註明卷次、冊次,然後加逗號;其餘與著作類格式同。
(b)第一例適用於編者未署名的文集;第二例適用於編者署名的文集。
(c)期刊、雜誌不必註明編者和出版者。
(5)引用報紙文章例:
陸全武:《國營企業改革中的幾個問題》,1994年8月20日《經濟日報》,第3版。
《墨西哥股票市場動盪》,1995年1月10日《人民日報》,第7版。
說明:(a)第一例適用於署名文章。
(b)第二例適用於不署名文章或報導。
(c)報紙出版時間須註明年、月、日,並置於報紙名稱前。
(d)報紙不注“頁”,而注“版”。
2、當再次引用同一著作中的資料時,注釋中只需注出作者姓名、著作名(副標題可省略)和資料所在的頁碼;如引文出自報刊文章,報刊名稱及出版日期則可以“上引報刊”四字代替。
例:李道揆:《美國政府和美國政治》,第79頁。
J.布盧姆:《美國的歷程》下冊第一分冊,第140頁。
陳寶森:《美國經濟與政府政策》,第435頁。
吳展:《試論核裁軍的幾個問題》,上引報刊,第44頁。
墨西哥股票市場動盪》,上引報刊,第7版。
英文注釋的格式
1、當首次引用一本著作的資料時,注釋中須將該書的作者姓名、書名、出版地、出版者、出版年代及資料所在頁碼順序註明。具體格式如下:
(1)專著類:
HaroldU.Faulkner,AmericanEconomicHistory(NewYork:Harper&BrothersPublishers,1960),pp.23-25.
說明:(a)作者姓名按通常順序排列,後面加逗號;書名用斜體,手稿中可在書名下用橫線標出;書名後緊接圓括弧,括弧內注出版地,加冒號,後接出版者名稱,再加逗號,然後注出版年代;括弧後面加逗號,再注出引用資料所在的頁碼,頁碼後加句號表示注釋完畢;單頁頁碼用p.表示;多頁頁碼用pp.表示,意為pages。(b)作者如系二人,作者姓名之間用and或&連線;如系二人以上,可寫出第一作者姓名,後面加etal.表示andothers,如:DonnaWorrallBrownetal.,ForminModernEnglish,其餘與(a)同。(c)著作名如有副標題,則以冒號將其與標題隔開,如:RobertK.Murray,TheHardingEra:WarrenG.HardingandHisAdministration(Minneapolis:UniversityofMinnesotaPress,1969),p.91.(d)著作如系多卷本中的一卷,須在註明頁碼前,用Vol.加羅馬數字標明卷數,如:RalphF.deBedts,RecentAmericanHistory:1945tothePresent,Vol.II(Illinois:DorseyPress,1973),p.169.
(2)編著類:
PaulM.Angle,ed.,TheAmericanReader:FromColumbustoToday(NewYork:RandMcNallyCo.,1958),pp.52-53.
說明:(a)如編者系多人,則須將ed.寫成eds.,如:E.B.White&KatherineS.White,eds.,ASubtreasuryofAmericanHumor,後面的注釋內容與著作類同。(b)既有編者又有著者的著作,須將著者姓名置於書名前,編者姓名置於書名後,如:GeorgeSoule,ProsperityDecade:FromWartoDepression,1917-1929(eds.HenryDavidetal.,NewYork:M.E.Sharpe,Inc.,1975),p.235.亦可不注編者,按著作類注釋處理。
(3)文集內文章:
ErwinPanofsky,“StyleandMediumintheMotionPicture,”ProblemsinAesthelics,ed.MorrisWeitz(NewYork:Harcourt,BraceandWorld,Inc.,1969),p.326.
說明:(a)文章名不用斜體或劃線,與其後的逗號均置於引號內。(b)書名採用斜體,後面注出編者姓名,格式與編著類(b)相同。
(4)報刊文章類:
ConstanceM.Drake,“AnApproachtoBlake,”CollegeEnglish,XXIX(April1968),pp.541-543.
“ReadingTeachersPutonSpot,”TheKansasCityStar,May1,1969,p.16A.
說明:(a)第一例為引用期刊中署名文章的注釋,期刊名稱用斜體,卷號須用羅馬數字標明,然後在圓括弧內注出版日期;不必注編者、出版者和出版地。(b)第二例為引用報紙中不署名文章的注釋,報紙名稱用斜體,後面注出版日期。
(5)電子信息類:
如使用網際網路上的資料,須註明資料所在站點詳細地址:
2、再次引用已引用過的著作時,注釋格式如下:
(1)僅注出作者姓名、頁碼即可,如:
Soule,p.229.
E.White&K.White,eds.,p.45.
(2)如在一篇文章中,引用了同一作者的兩本(篇)或兩本(篇)以上的著作,則須加注書名,
如:Soule,ProsperityDecade,p.134.
(3)本注與緊鄰之上注所引資料出於同一著作,可以ibid.代替,意為“引書同上”或“出處同上”(如本注所引著作並非與緊鄰之上注、而是與間隔之上注相同,則不可用ibid.代替),如:
③HaroldU.Faulkner,AmericanEconomicHistory(NewYork:Harper&BrothersPublishers,1960),pp.23-25.
④Ibid.,p.51(意為與注釋③引書相同,頁碼不同)
⑤Ibid.(意為與注釋④引書及頁碼都相同)
程式語言的注釋格式
注釋就是對代碼的解釋和說明。目的是為了讓別人和自己很容易看懂。為了讓別人一看就知道這段代碼是做什麼用的。正確的程式注釋一般包括序言性注釋和功能性注釋。序言性注釋的主要內容包括模組的接口、數據的描述和模組的功能。模組的功能性注釋的主要內容包括程式段的功能、語句的功能和數據的狀態。

相關詞條

相關搜尋

熱門詞條

聯絡我們