99999久久久久久亚洲,欧美人与禽猛交狂配,高清日韩av在线影院,一个人在线高清免费观看,啦啦啦在线视频免费观看www

熱線電話：13121318867

登錄
首頁精彩閱讀Python快速從注釋生成文檔的方法
Python快速從注釋生成文檔的方法
2018-06-01
收藏

Python快速從注釋生成文檔的方法

作為一個標準的程序猿，為程序編寫說明文檔是一步必不可少的工作，如何才能寫的又好又快呢，下面我們就來詳細探討下吧。

今天將告訴大家一個簡單平時只要注意的小細節(jié)，就可以輕松生成注釋文檔，也可以檢查我們寫的類方法引用名稱是否重復有問題等。

一看別人專業(yè)的大牛們寫的文檔多牛多羨慕，不用擔心我們可以讓python為我們生成基本滿足的說明文檔，一來可以提高代碼整體閱讀性，二來可以將代碼的整體結構看著也更清晰，這樣在交接的時候可以省很多麻煩，其它同事在接手你工作的時候也不會一行行去問你這是什么那是什么的，因為注釋已經(jīng)很直觀的表述了，在整合的時候可當說明文檔給客戶簡單說明(主要是給你BOSS看的).

那么進入正題怎么實現(xiàn)看下面我簡單的代碼格式，注意注釋的地方和函數(shù)名類名都是與__all__內(nèi)相關聯(lián)的

#!/usr/bin/env python
 
# -*-coding:utf-8 -*-
 
'''
 
  
文檔快速生成注釋的方法介紹,首先我們要用到__all__屬性
 
在Py中使用為導出__all__中的所有類、函數(shù)、變量成員等
 
在模塊使用__all__屬性可避免相互引用時命名沖突
 
'''
 
__all__=['Login','check','Shop','upDateIt','findIt','deleteIt','createIt']
 
classLogin:
 
'''
 
測試注釋一可以寫上此類的作用說明等
 
例如此方法用來寫登錄
 
'''
 
def__init__(self):
 
'''
 
初始化你要的參數(shù)說明
 
那么登錄可能要用到
 
用戶名username
 
密碼password
 
'''
 
pass
 
defcheck(self):
 
'''
 
協(xié)商你要實現(xiàn)的功能說明
 
功能也有很多例如驗證
 
判斷語句，驗證碼之類的
 
'''
 
pass
 
classShop:
 
'''
 
商品類所包含的屬性及方法
 
update改/更新
 
find查找
 
delete刪除
 
create添加
 
'''
 
def__init__(self):
 
'''
 
初始化商品的價格、日期、分類等
 
'''
 
pass
 
defupDateIt(self):
 
'''
 
用來更新商品信息
 
'''
 
pass
 
deffindIt(self):
 
'''
 
查找商品信息
 
'''
 
pass
 
defdeleteIt(self):
 
'''
 
刪除過期下架商品信息
 
'''
 
pass
 
defcreateIt(self):
 
'''
 
創(chuàng)建新商品及上架信息
 
'''
 
pass
 
if__name__=="__main__":
 
importpythonzhushi
 
printhelp(pythonzhushi)

這里要強調(diào)說明下py的名字要和你當前工作的py名字一樣(我這里創(chuàng)建的py名字就是pythonzhushi,最后導入也是這名字)，因為下面的測試中import的導入的是自身所以,im port 名稱 和Help(名稱)以及你的文件名稱要一致才可以。為了更加直觀請看下面這圖：

當然還可以從其它文件引用的方式導入這里用到python常用的導入方式from從哪個目錄import導入什么文件pythonzhushi

當然我這里還是用圖片來展示以下：



是不是一目了然，這樣也可以導入我們需要做的注釋文檔，help幫助方法就是幫我們查看到此文件中所包含的類，函數(shù),的一個簡單幫助文檔，類似于readme文檔的一個說明。最后來看看掩飾效果吧：



是不是簡單的打印出我們程序的說明文檔，后面步驟直接可以建一個文本把這個粘貼過去，就完成一個readme的文檔說明，經(jīng)過測試有幾點注意是，想要寫#這種注釋不要寫到def放發(fā)內(nèi)要寫到它的上面位置和裝飾器類似，相反三引號'''不要寫到def外面,這樣也是沒顯示效果的。大家趕緊去試試吧。感謝觀看。。

數(shù)據(jù)分析咨詢請掃描二維碼

若不方便掃碼，搜微信號：CDAshujufenxi

數(shù)據(jù)分析師資訊
更多

OK
客服在線
立即咨詢
客服在線
立即咨詢
') } function initGt() { var handler = function (captchaObj) { captchaObj.appendTo('#captcha'); captchaObj.onReady(function () { $("#wait").hide(); }).onSuccess(function(){ $('.getcheckcode').removeClass('dis'); $('.getcheckcode').trigger('click'); }); window.captchaObj = captchaObj; }; $('#captcha').show(); $.ajax({ url: "/login/gtstart?t=" + (new Date()).getTime(), // 加隨機數(shù)防止緩存 type: "get", dataType: "json", success: function (data) { $('#text').hide(); $('#wait').show(); // 調(diào)用 initGeetest 進行初始化 // 參數(shù)1：配置參數(shù) // 參數(shù)2：回調(diào)，回調(diào)的第一個參數(shù)驗證碼對象，之后可以使用它調(diào)用相應的接口 initGeetest({ // 以下 4 個配置參數(shù)為必須，不能缺少 gt: data.gt, challenge: data.challenge, offline: !data.success, // 表示用戶后臺檢測極驗服務器是否宕機 new_captcha: data.new_captcha, // 用于宕機時表示是新驗證碼的宕機 product: "float", // 產(chǎn)品形式，包括：float，popup width: "280px", https: true // 更多配置參數(shù)說明請參見：http://docs.geetest.com/install/client/web-front/ }, handler); } }); } function codeCutdown() { if(_wait == 0){ //倒計時完成 $(".getcheckcode").removeClass('dis').html("重新獲取"); }else{ $(".getcheckcode").addClass('dis').html("重新獲取("+_wait+"s)"); _wait--; setTimeout(function () { codeCutdown(); },1000); } } function inputValidate(ele,telInput) { var oInput = ele; var inputVal = oInput.val(); var oType = ele.attr('data-type'); var oEtag = $('#etag').val(); var oErr = oInput.closest('.form_box').next('.err_txt'); var empTxt = '請輸入'+oInput.attr('placeholder')+'！'; var errTxt = '請輸入正確的'+oInput.attr('placeholder')+'！'; var pattern; if(inputVal==""){ if(!telInput){ errFun(oErr,empTxt); } return false; }else { switch (oType){ case 'login_mobile': pattern = /^1[3456789]\d{9}$/; if(inputVal.length==11) { $.ajax({ url: '/login/checkmobile', type: "post", dataType: "json", data: { mobile: inputVal, etag: oEtag, page_ur: window.location.href, page_referer: document.referrer }, success: function (data) { } }); } break; case 'login_yzm': pattern = /^\d{6}$/; break; } if(oType=='login_mobile'){ } if(!!validateFun(pattern,inputVal)){ errFun(oErr,'') if(telInput){ $('.getcheckcode').removeClass('dis'); } }else { if(!telInput) { errFun(oErr, errTxt); }else { $('.getcheckcode').addClass('dis'); } return false; } } return true; } function errFun(obj,msg) { obj.html(msg); if(msg==''){ $('.login_submit').removeClass('dis'); }else { $('.login_submit').addClass('dis'); } } function validateFun(pat,val) { return pat.test(val); }