10个最“优秀”的代码注释

[赏析]10个最“优秀”的代码注释

2011-11-22 08:36 | 86次阅读 | 来源:外刊IT评论 【已有0条评论】发表评论

关键词:代码注释 | 作者:外刊IT评论 | 收藏这篇资讯

下面是stackoverflow网站上网友针对你看到过的最好的代码注释是什么样的?这个问题给出的回答的前10条:

1.

// 亲爱的维护者:

// 如果你尝试了对这段程序进行‘优化’,

// 并认识到这种企图是大错特错,请增加

// 下面这个计数器的个数,用来对后来人进行警告:

// 浪费在这里的总时间 = 39h

2.

/** * 致终于来到这里的勇敢的人:

你是被上帝选中的人,英勇的、不辞劳苦的、不眠不修的来修改

我们这最棘手的代码的编程骑士。你,我们的救世主,人中之龙,

我要对你说:永远不要放弃,永远不要对自己失望,永远不要逃走,辜负了自己。

永远不要哭啼,永远不要说再见。永远不要说谎来伤害自己。 */ 

3.

Exception up = new Exception("Something is really wrong."); throw up;  

4.

// 一些修改1 - 2002/6/7 增加临时的跟踪登录界面

// 一些修改2 - 2007/5/22 我临时的犯傻 

5.

 #define TRUE FALSE //逗一逗调试程序的傻瓜们

6.

if (/*you*/ $_GET['action']) { //celebrate(恭喜)

7.

// 如果这段代码好用,那它是Paul DiLascia写的。

//如果不好用,我不知道是谁写的。 

8.

//写这段代码的时候,只有上帝和我知道它是干嘛的

//现在,只有上帝知道 

9.

 // 晕了,以后再修改

10.

 // 神奇。勿动。

你有没有更绝的?

文章出自:外刊IT评论

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
当然,下面是代码注释: ```python import random # 定义一个列表,里面有一些字符串元素 words = ['python', 'java', 'kotlin', 'javascript', 'swift'] # 随机选择一个字符串元素 chosen_word = random.choice(words) # 定义一个列表,用来保存猜测的字母 display = ['_'] * len(chosen_word) # 定义一个变量,用来记录猜测的次数 guess_count = 0 # 定义一个变量,用来记录游戏是否结束 game_over = False # 输出游戏欢迎语 print("Welcome to Hangman game!") # 游戏开始循环 while not game_over: # 输出当前猜测的字母状态 print(' '.join(display)) # 让用户输入一个字母 guess = input("Guess a letter: ").lower() # 如果用户猜测的字母已经在列表中,则提示用户重新输入 if guess in display: print("You've already guessed this letter. Please try again.") else: # 猜测次数加1 guess_count += 1 # 遍历被猜测的单词中的每一个字母 for i in range(len(chosen_word)): # 如果这个字母和用户猜测的字母相同,则在display列表中替换对应的下划线 if chosen_word[i] == guess: display[i] = guess # 判断游戏是否结束 if '_' not in display: game_over = True print('You win!') elif guess_count == 6: game_over = True print('You lose! The word was', chosen_word) ``` 注释: ```python import random # 定义一个列表,里面有一些字符串元素 words = ['python', 'java', 'kotlin', 'javascript', 'swift'] # 随机选择一个字符串元素 chosen_word = random.choice(words) # 定义一个列表,用来保存猜测的字母 display = ['_'] * len(chosen_word) # 定义一个变量,用来记录猜测的次数 guess_count = 0 # 定义一个变量,用来记录游戏是否结束 game_over = False # 输出游戏欢迎语 print("Welcome to Hangman game!") # 游戏开始循环 while not game_over: # 输出当前猜测的字母状态 print(' '.join(display)) # 让用户输入一个字母 guess = input("Guess a letter: ").lower() # 如果用户猜测的字母已经在列表中,则提示用户重新输入 if guess in display: print("You've already guessed this letter. Please try again.") else: # 猜测次数加1 guess_count += 1 # 遍历被猜测的单词中的每一个字母 for i in range(len(chosen_word)): # 如果这个字母和用户猜测的字母相同,则在display列表中替换对应的下划线 if chosen_word[i] == guess: display[i] = guess # 判断游戏是否结束 if '_' not in display: game_over = True print('You win!') elif guess_count == 6: game_over = True print('You lose! The word was', chosen_word) ``` 这段代码实现了一个猜单词的游戏,具体注释解释如下: 1. 第一行导入Python的random模块,用于后面随机选择一个单词。 2. 第3行定义一个列表words,包含了一些单词。 3. 第6行随机选择一个单词。 4. 第9行定义一个列表display,长度与被选择的单词相同,用来记录当前猜测的字母状态。 5. 第12行定义一个变量guess_count,用来记录猜测的次数。 6. 第15行定义一个变量game_over,用来记录游戏是否结束。 7. 第18行输出游戏欢迎语。 8. 第21行开始游戏循环,当game_over为True时跳出循环。 9. 第24行输出当前猜测的字母状态,用join函数将列表中的元素以空格连接起来。 10. 第27行让用户输入一个字母,用lower函数将字母转换为小写。 11. 第30-34行,如果用户已经猜过这个字母,则提示用户重新输入。 12. 第35-40行,如果用户猜对了,则在display列表中替换对应的下划线,猜测次数加1。 13. 第43-49行,判断游戏是否结束,如果没有下划线了则赢了,如果猜测次数达到了6次则输了,同时输出被猜测的单词。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值