Question

我正在完成我的第一个“真实世界”计划，我不确定评论的评论太多。添加评论时最佳做法是什么？我是否要解释每一步或不解释“如何”，更多地关注“为什么”或者没有太多的评论？

Answer 1

实际上，如果您在团队中工作，那么您应该有一定数量的评论/文档。如果您要为自己保留代码，则可以根据需要使用尽可能少的注释。尽管如此，您应该尝试保持代码清洁，可读，并且易于理解，只需要一点点思考即可。如果您通过使用函数/方法保持代码模块化，则应该描述该函数正在执行的操作。例如：

# Calls LS on the ROOT directory then prints output
def main():
    bashCommand = "ls /"
    process = subprocess.Popen(bashCommand.split(), stdout=subprocess.PIPE)
    output = process.communicate()[0]
    print output

一个不好的做法是将相当多的代码注释掉（在您的最终产品中）。以下是不良做法的一个例子：

def searchPcGame(game):
    #need to parse id="search_items"
    url = 'http://www.pcgamer.com/search/%s' %game
    rv = requests.get(url)
    soup=BeautifulSoup(rv.text)
    zz = soup.find_all(id="search_items")
    titles = [a.get_text() for a in soup.find_all('h3')]
    # zzSoup = BeautifulSoup(zz.text)
    # foo = []
    # foo.append(articlesSoup)
    # return titles
    return zz

你应该在一个程序中加注多少评论？

1 个答案: