Python中的个人评论风格(章节、子章节等)[已关闭]

aydmsdu9  于 2023-01-14  发布在  Python
关注(0)|答案(1)|浏览(117)
    • 已关闭**。此问题为opinion-based。当前不接受答案。
    • 想要改进此问题吗?**请更新此问题,以便editing this post可以用事实和引文来回答。

昨天关门了。
Improve this question
我希望得到一些关于如何使用注解来指定代码的特定部分的想法,即人们用来指定代码的主要部分或子部分等的注解样式。
例如,这里有一些我见过的评论"section style",我很想看看人们使用的其他评论:

# "main section" examples:

# +---------------+
# |   Functions   |
# +---------------+

# +=-=-=-=-=-=-=-=+
# |   Functions   |
# +=-=-=-=-=-=-=-=+

#################
#   Functions   #
#################

"""
   +---------------+
   |   Functions   |
   +---------------+
"""

"""
   +=-=-=-=-=-=-=-=+
   |   Functions   |
   +=-=-=-=-=-=-=-=+
"""

sub-section examples:

# |--- User Input ---|

# === User Input ===

# +-- User Input --+

### User Input ###

因此,这些"评论区样式"可以用在如下脚本中:

# Main.py

import stuff
import morestuff

# +---------------+
# |   Functions   |
# +---------------+

# |--- Print Hello World ---|
def print_hw()
   print("Hello World")

"""
   +=-=-=-=-=-+
   |   Main   |
   +=-=-=-=-=-+
"""

# === Print ===
print_hw()

但是我不知道什么看起来最好,或者是否有其他的方式来指定代码中的"部分"?Python比较新,所以希望学习其他人是如何做这类事情的。谢谢!

s3fp2yjn

s3fp2yjn1#

1.如果你在一个组织里工作,看看别人是怎么做的,然后跟着做。我这么说是因为新员工倾向于使用他们自己的想法,这会产生不必要的冲突。
1.如果这是个人或学校使用,那么选择一个并坚持下去。我在顶部和主要部分使用粗体和粗体来吸引注意力,在子部分使用细长和整洁的字体。

相关问题