首页 > 解决方案 > Python 中的节标题注释

问题描述

我在 Google 上搜索过,找不到任何关于用注释突出显示代码部分的推荐方法的信息。

我在想这样的事情:

###########################################################
# This section is clearly labeled using comments so you can 
# instantly identify its purpose within this file.
###########################################################

例如,我经常看到这种事情php

python中有这种东西的约定吗?如果没有,是否有充分的理由避免它?

如果这通常是使用多行注释完成的,有人可以提供一个示例,说明它是如何以这种“标题”样式完成的吗?

编辑:我知道多行评论。但通常我将这些与单个函数而不是一段代码相关联。所以更具体地说,我正在为单个文件中的小游戏考虑这样的事情:

###################################################
#              CONFIGURATION   
##################################################

configuration code...

###################################################
#              HELPER FUNCTIONS
#################################################   

helper functions.....

###################################################
#                 GRAPHICS HANDLING
#######################################################

graphics handling....

标签: pythoncomments

解决方案


##############
# Game Setup #
##############

code...

##################
# Function Setup #
##################

code...

################
# Screen Setup #
################

code...

这就是我的意思。在https://github.com/lordmauve/pgzero找到了一些很好的例子


推荐阅读