Python の docstring とコメントの違いについて少し混乱しています。
私のクラスで、私の先生は「デザイン レシピ」として知られるものを紹介しました。これは、学生が Python でコーディングをより適切にプロットして整理するのに役立つと思われる一連の手順です。私が理解していることから、以下は私たちが従う手順の例です-これはいわゆるデザインレシピ（引用符内のもの）です：
def term_work_mark(a0_mark, a1_mark, a2_mark, ex_mark, midterm_mark):
''' (float, float, float, float, float) -> float
Takes your marks on a0_mark, a1_mark, a2_mark, ex_mark and midterm_mark,
calculates their respective weight contributions and sums these
contributions to deliver your overall term mark out of a maximum of 55 (This
is because the exam mark is not taken account of in this function)
>>>term_work_mark(5, 5, 5, 5, 5)
11.8
>>>term_work_mark(0, 0, 0, 0, 0)
0.0
'''
a0_component = contribution(a0_mark, a0_max_mark, a0_weight)
a1_component = contribution(a1_mark, a1_max_mark, a1_weight)
a2_component = contribution(a2_mark, a2_max_mark, a2_weight)
ex_component = contribution(ex_mark, exercises_max_mark,exercises_weight)
mid_component = contribution(midterm_mark, midterm_max_mark, midterm_weight)
return (a0_component + a1_component + a2_component + ex_component +
mid_component)
私が理解している限り、これは基本的に docstring であり、私たちのバージョンの docstring では、説明、Python シェルに入力した場合に関数が何をすべきかの例、および「型コントラクト」の 3 つを含める必要があります。入力した型と関数が返す型を示すセクション。
これですべてが完了しましたが、割り当てには、トークン '#' 記号を使用して、関数の性質を説明するコメントも必要です。
ですから、私の質問は、docstring の説明セクションで関数が何をするかを既に説明していませんか? 基本的にまったく同じことを読者に伝えている場合、コメントを追加する意味は何ですか?