使用DocStrings為python函式添加註釋

阿新 • • 發佈：2019-01-15

有過Java或AS3程式設計經驗的碼農，有Eclipse或者Flash Builder這樣的強大IDE輔助下，不難有這樣的經驗：

當你想知道一個函式是做什麼用的時候，只要將滑鼠輕輕撫摸目標函式，就會這樣

只要這個函式進行了這樣的註釋

/**
* 飛行離開新手村，給玩家設定師傅形象
* 非常噁心，不要往下看了
*/		
public function setMaster(npcId:int):void
{
	updateStyle(_style[0],_style[1], _rideId, npcId,_isBlack,hideSuit,_mountAvoid, _isSit, false, _isHeaven);
}

那麼python能不能這樣呢，答案是肯定的。

使用DocStrings(文件字串)為python函式添加註釋，like this

def docString_test():
  '''This is a DocString test function,

  enjoy it.'''

你可以

print docString_test.__doc__

輸出：

This is a DocString test function,

  enjoy it.

也可以

help(docString_test)

輸出

Help on function docString_test in module __main__:

docString_test()
    This is a DocString test function,
    
    enjoy it.

這裡有一些慣例希望每一個pythoner遵循：

引用自python簡明教程：文件字串的慣例是一個多行字串，它的首行以大寫字母開始，句號結尾。第二行是空行，從第三行開始是詳細的描述。強烈建議你在你的函式中使用文件字串時遵循這個慣例。

enjoy it.

使用DocStrings為python函式添加註釋

有過Java或AS3程式設計經驗的碼農，有Eclipse或者Flash Builder這樣的強大IDE輔助下，不難有這樣的經驗：當你想知道一個函式是做什麼用的時候，只要將滑鼠輕輕撫摸目標函式，就會這樣只要這個函式進行了這樣的註釋 /** * 飛行離開新手村，給玩家設

批處理實現：批量為文件添加註釋

技術 inf 註釋 image color pan div 批處理 nbsp 問：答： 1、目錄結構 2、實現代碼 @echo off for /f "delims=" %%i in (‘dir /b src\*.c

Python 如何添加註釋

一、在Python檔案中，前面兩行建議新增下面兩行註釋： #!/usr/bin/env python3 # -*- coding: utf-8 -*- 第一行註釋，是為了告訴Linux/OS X系統，這是一個Python可執行程式，Windows系統會忽略這個註釋；第二行註釋，是為

C#中給函式添加註釋小技巧

1、多行註釋是比較常用的。快捷鍵如下：註釋：先按Ctrl+K，再按Ctrl+C 取消註釋：先按Ctrl+K，再按Ctrl+U （注意，是“U”，不是“V”） 2、有個非常簡單的用法，就是“///”

如何為eclipse程式碼添加註釋模版，註釋快捷鍵？

python基礎===monkeytype可以自動添加註釋的模塊！

dir mon working app som 我們 test img htm monkeytype 一個可以自動添加註釋的模塊！先要下載： pip install monkeytype 以官網的sample code為例 #moudle.py def add

為Keil添加註釋的快捷鍵

Keil剛裝上是沒有註釋快捷鍵的，可以自己新增，“Edit”-“Configuration”，然後選擇“Shortcut Keys”標籤頁，下拉找到“Comment Selection”，然後點右邊的“Create Shortcut”就可以自己輸入快捷鍵了，確定後即可生效。 “Comm

VS2010利用巨集快速添加註釋（函式描述，修改註釋等）

在敲程式碼的過程中類和函式都需要進行註釋，但總是一遍一遍的複製貼上覺得很是麻煩，終於找到了一個不錯的解決方法：使用巨集。所謂巨集，就是一些命令組織在一起，作為一個單獨命令完成一個特定任務。在日常的辦公環境中，不論是Office還是Foxmail以及我們所使用的

eclipse中如何為生成的get/set方法添加註釋

我需要這樣的get/set方法 /** * 獲取起始頁 * * @return the startIndex */ public int getStartIndex() { return startIndex; } /** * 設定起始頁

程式碼規範之在函式之前添加註釋

開發中，我們常常要為自己寫的函式新增作者、引數的說明等資訊，可以採用如下的方式： /** * @author 小明（我的工位a89） * @param name:使用者名稱 * @par

在後臺為查詢表格添加固定過濾條件

alt bool logs 表格查詢 src str bsp boolean 一、新建一個列表頁面，在頁面中功能中增加如下配置：二、寫一個handler處理類：在filterItems中加入固定的過濾條件即可或者 FilterInfo fil

SVN提交強制添加註釋信息

svn在SVN管理上很多同事為了方便直接提交，不填寫註釋，在日後的管理上造成很大的麻煩，在此通過pre-commit腳本進行控制，提交時不能少於5個字符，否則不予提交。REPOS="$1" TXN="$2" SVNLOOK=/usr/bin/svnlook LOGMSG=`$SVNLOOK log -t "

通過編程為Outlook 2007添加郵件規則

str href intern creat rule XML ons gen 小程序 Outlook 所支持的郵件規則相當有用，我們經常需要針對某些特征的郵件做特殊的處理。例如將其移動到某個特定文件夾，或者刪除它等等。 Outlook所支持的郵件規則主要兩大類：收到郵件時和

JS實現為控件添加倒計時功能

設置 .net right ble tro string star js實現格式化時間一.概述在有些報表需求中，需要為控件添加倒計時功能，限制到某一個時間點後能進行一項操作或不能進行某項操作，比如查詢，導出功能等等，又需要人性化地顯示還有多少時間，即倒計時功能，比如下

oracle 給表和字段添加註釋

oracle 註釋備註comment on column TableName.ColumnName is ‘備註名’;comment on table TableName is ‘備註名‘;oracle 給表和字段添加註釋

python django添加靜態資源

django靜態資源在setting中確認以下：STATIC_URL = ‘/static/‘將靜態目錄放到app下，在app中創建static目錄，然後再創建css、js、image。在html中添加靜態資源的路徑： {% load staticfiles %} <link rel="styles

Eclipse中自動添加註釋（作者，時間）

ava 進入 new java 模式 window templates nts 自動方法一：Eclipse中設置在創建新類時自動生成註釋 windows-->preference Java-->Code Style-->Code Templates co

python中添加環境變量

end pat 而且模塊存在輸入示例 tro project import sys sys.path 系統環境是一個list，可以將自己需要的庫添加進入，例如mysql庫，hive庫等等。有三種方式添加，均驗證通過： 1 臨時添加，在一個shell窗口中 i

為博客添加目錄

san view val crt leave important con 表達式 als 主要參考來源：http://www.cnblogs.com/xuehaoyue/p/6650533.html#_labelTop 在文章左邊角添加目錄導航 1. 申

為輸入框添加字數提示

計算 return func str 輸入框 parse input type byte 計算字符串長度，中文1，其他0.5： 1 var getByteLen=function(str) { 2 if (str == null) return 0; 3

使用DocStrings為python函式添加註釋

相關推薦