关于python函数注释模板的信息

Python大佬啊帮我再写一个英文注释吧,解释各步骤,谢谢啦代码示例
# 写一个Python函数,其说明如下:
# def get_word_score(word):
# word: string
# returns: int = 0
# 函数返回单词word的得分 。一个单词的得分是单词中所有字母的得分
# 之和 。单词中每个字母的得分在下面的字典SCRABBLE_LETTER_VALUES
# 中表示 。字母不区分大、小写 。例如'e'和'E'的得分都是1,'p'和'P'
# 的得分都是3 。单词'egg'的得分是1+2+2=5,单词'No'的得分是1+1=2 。
# 假设输入的word是一个单词或空字符串"" 。字符串中可以有大写和小写
# 字母 , 在函数中应处理word中出现大写字母的情况 。
# 请使用具体的字符串实例测试此函数
# SCRABBLE_LETTER_VALUES = {
# 'a': 1, 'b': 3, 'c': 3, 'd': 2, 'e': 1, 'f': 4, 'g': 2, 'h': 4, 'i': 1, 'j': 8, 'k': 5, 'l': 1, 'm': 3, 'n': 1, 'o': 1, 'p': 3, 'q': 10, 'r': 1, 's': 1, 't': 1, 'u': 1, 'v': 4, 'w': 4, 'x': 8, 'y': 4, 'z': 10
# }
# 下面是一个运行示例:
# Score of 'About'is 7
def get_word_score(word):# 定义获取单词分数方法
if not word:# 如果输入单词为空
return 0# 则返回0
SCRABBLE_LETTER_VALUES = {# 定义每个字母的分数
'a': 1, 'b': 3, 'c': 3, 'd': 2, 'e': 1, 'f': 4, 'g': 2,
'h': 4, 'i': 1, 'j': 8, 'k': 5, 'l': 1, 'm': 3, 'n': 1,
'o': 1, 'p': 3, 'q': 10, 'r': 1, 's': 1, 't': 1,
'u': 1, 'v': 4, 'w': 4, 'x': 8, 'y': 4, 'z': 10
}
word = word.lower()# 输入单词全部转换成小写
score = 0# 定义分数,初始化为0
for c in word:# 遍历输入字符
score += SCRABBLE_LETTER_VALUES[c]# 累加每个字母的得分
return score# 输入单词最终得分
if __name__ == '__main__':# 定义程序运行入口
print('please input the word:')# 输入提示信息
w = input()# 获取输入的单词
print('Score of \'{}\' is {}'.format(w, get_word_score(w)))# 输出输入单词得分
Python命名规则与注释风格名称不要缩写?。。?
名称不要缩写?。。?
名称不要缩写?。。?
包命名:小写,下划线_连接单词
模块命名:小写,下划线_连接单词
类命名:双驼峰,MyClass
函数命名:小写,下划线_连接单词
全局变量:每个字母大写
注释很重要,要注明函数或类的功能,参数的数据类型、含义等 。
注释模板:
注释的作用:
Python有句话是do not repeat yourself , 即不要做重复的事,因此出现了类或函数的封装和继承 , 基于此可提高代码的重复利用性 。
Python有哪几种注释方式python中的注释有单行注释和多行注释:
1、单行注释(行注释)
python中使用#表示单行注释 。单行注释可以作为单独的一行放在被注释代码行之上 , 也可以放在语句或表达式之后 。
比如:
# 这是一个注释
print("Hello, World!")
①当单行注释作为单独的一行放在被注释代码行之上时 , 为了保证代码的可读性,建议在#后面添加一个空格,再添加注释内容 。
②当单行注释放在语句或者表达式之后时,同样为了保证代码的可读性,建议注释和语句之间至少要有两个空格 。
2、多行注释(块注释)
当注释内容过多,导致一行无法显示时,就可以使用多行注释 。多行注释用三个单引号'''或者三个双引号 """将注释括起来 。
①单引号(''')
'''
这是多行注释,用三个单引号
这是多行注释,用三个单引号
这是多行注释,用三个单引号
'''
print("Hello, World!")
②双引号(""")
"""
这是多行注释,用三个双引号

推荐阅读