Dear all,
I would like to know if there is some recommendation about comments in source file.
Can I put much as I like without losing memory?
Thanks in advance for your comments and suggestions
Best regargs
About comments on main.py source code
Re: About comments on main.py source code
Actual comments starting with a hash # are removed by the lexer and take no RAM. They only take space in the file itself. So you can write as many as you like.
Strings/doc-strings as comments do take some amount of RAM when compiling so better to avoid them.
Strings/doc-strings as comments do take some amount of RAM when compiling so better to avoid them.
-
- Posts: 24
- Joined: Mon Apr 27, 2015 8:25 am
Re: About comments on main.py source code
Thank for the response
Re: About comments on main.py source code
Interesting to know. Can you recommend some '#'-based comment style for the generation of documentation from code? I am thinking of some drivers which might need some love and could generate nice "Read the Docs" documentation. I hope that is reasonable!?
Re: RE: Re: About comments on main.py source code
I'd put restructured text in the comments. Easy to extract (just strip leading #) and then pass to sphinx.kfricke wrote: Can you recommend some '#'-based comment style for the generation of documentation from code?