Section Header Comments in Python

Question

I've searched on Google and could not find any information on recommended ways to highlight sections of code with comments.

I'm thinking of something like this:

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

I see this kind of thing a lot in php for example.

Is there a convention for this kind of thing in python? If not, is there a good reason to avoid it?

If this is generally done using multi-line comments, could someone please provide an example of how it's done in this "headline" style?

EDIT: I know about multi-line comments. But generally I associate these with a single function rather than a section of code. So more specifically I'm thinking something like this for a small game in a single file:

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

configuration code...

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

helper functions.....

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

graphics handling....

Take a look at this? stackoverflow.com/questions/7696924/… — Devesh Kumar Singh
– Devesh Kumar Singh, Commented Jul 27, 2019 at 7:56
In Spyder, you can use # %% Section Header to mark a collapsible section of code. I have no idea if that's just in Spyder or a more widespread convention. — Joooeey
– Joooeey, Commented Sep 14, 2022 at 7:36

Robin Andrews · Accepted Answer · 2019-08-25 21:02:52Z

3

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

code...

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

code...

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

code...

That's the kind of thing I meant. Found some good examples in https://github.com/lordmauve/pgzero

answered Aug 25, 2019 at 21:02

Robin Andrews

3,84212 gold badges56 silver badges129 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Section Header Comments in Python

1 Answer 1

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related