आपकी राय में एक सार्थक डॉकस्ट्रिंग क्या है? आप वहां क्या वर्णन करने की उम्मीद करते हैं? उदाहरण के लिए, पर विचार यह अजगर वर्ग के __init__: def __init__(self, name, value, displayName=None, matchingRule
वह कुछ इस तरह लिखने के लिए मान्य JavaScript है: function example(x) {
"Here is a short doc what I do.";
// code of the function
}
स्ट्रिंग वास्तव में कुछ नहीं करता है। क्या कोई कारण है, इ
मैं अपनी पायथन परियोजनाओं में परीक्षणों की संख्या और गुणवत्ता में सुधार करने की कोशिश कर रहा हूं। परीक्षणों की संख्या में वृद्धि की कठिनाइयों में से एक यह जानना है कि प्रत्येक परीक्षण क्या करता है और
मुझे सजावटी के साथ डॉकस्ट्रिंग का उपयोग करने में समस्या है। निम्न उदाहरण को देखते हुए: def decorator(f):
def _decorator():
print 'decorator active'
f()
return _decorator
@decor
के साथ पायथन कोड को कैसे दस्तावेज़ित करें मुझे सी या PHP कोड के दस्तावेज़ बनाने के लिए डॉक्सिजन पसंद है। मेरे पास एक आगामी पायथन परियोजना है और मुझे लगता है कि मुझे याद है कि पायथन में /* .. */ टिप्पण