零到一学Python：代码格式、注释和命名规范

Java领域新星创作者

博客专家认证

2024-09-03 10:44:32

零到一学Python：代码格式、注释和命名规范

...全文

39 回复打赏收藏转发到动态举报

写回复

回复

切换为时间正序

请发表友善的回复…

发表回复

想从事软件开发行业的朋友会有用到的，分享下大公司里面的编程规范。

如无特殊情况, 文件一律使用 UTF-8 编码如无特殊情况, 文件头部必须加入标识。每行代码尽量不超过 80 个字符(在特殊情况下可以略微超过 80 ，但最长不得超过 120) import语句应该放在文件头部，置于模块说明及docstring之后，于全局变量之前； import语句应该按照顺序排列，每组之间用一个空行分隔 Python 支持括号内的换行。这时有两种情况。所有的公共模块、函数、类、方法，都应该写 docstring 。

Python：代码规范和命名规范 所有命名规范都要准守这三条： 1.命名只能以字母或者_下划线开头； 2.名字不能包含空格； 3.名字不能与关键字重合。不能将字符l(小写字母l)，'O''o'(大小写字母o)、'I'(大写字母I)用作变量名称，防止和数字0、1混淆。模块模块尽量使用小写命名，首字母保持小写，尽量不要用下划线(除非多个单词，且数量不多的情况)。 # 正确的模块名 import decoder import html_decoder # 不推荐的模块名 import .

标签（空格分隔）： python PEP8 代码规范在日常工作中，编写python代码时，大家有可能因为IDE的不同或者是没有遵循python的pep8规范而导致每个人的格式都不尽相同，导致其他人阅读起来比较吃力。但是有时候代码规范也并不是建议使用的，最主要的是风格一致性，每个组内的代码风格统一起来才是最重要的，根据自己的判断选择是否遵循PEP8。 ps: 许多项目有自己的编码规范，在出现规范冲突时，项目自身的规范优先。接下来我们只挑一些在工作中频繁遇到规范进行示例，为减少大家阅读时间，以推荐和

Python注释规范摘要： Python提供多种注释方式，包括单行注释（#）、多行注释（三引号）和文档字符串（Docstring）。单行注释用于简短说明或临时禁用代码，多行注释适用于大段说明或调试。文档字符串是官方推荐的代码文档方式，用于解释模块、类、函数的功能和参数。注释内容应遵循规范：函数/方法注释需说明功能、参数和返回值；类注释应描述整体用途和属性；模块注释位于文件顶部，包含功能和版本信息。代码块注释用于解释复杂逻辑，行内注释则针对特定代码行。

Java程序员进阶之路

291,347

社区成员

5,974

社区内容

发帖

与我相关

我的任务

社区管理员

加入社区

近7日
近30日
至今

加载中

查看更多榜单

社区公告

暂无公告

试试用AI创作助手写篇文章吧

+ 用AI写文章