2021-02-21 代码不规范，运维两行泪代码规范

￡神魔★判官ぃ 2022-10-31 04:08 128阅读 0赞

## 代码不规范，运维两行泪 ##

编程江湖中一直盛传着一个段子，那就是要问程序员最讨厌哪 4 件事？那必须是：写注释、写文档、别人不写注释、别人不写文档。

动手写代码前尽量做到**心中有数，思考清楚代码框架结构。现在这世界讲究格局，写代码亦然。** 写代码前先回答这么几个问题——这段代码的核心功能是什么？实现它的核心功能需要实现哪些functions? 这些functions需要设计哪些相应的class？这些class如何尽量做到继承，能否从已有的代码库里进行继承来避免重复开发？

**能高效一行写完的绝不写两行。** 举个简单的python 例子，想要得到0到10的偶数，大部分人会通过遍历+if判断写几行代码，但完全可以通过一行代码达到结果

y = [x for x in range(10) if x % 2==0]

**做好文档规整。** 程序员的工作不是学完代码就拉倒的，还包括整理好自己代码的文档介绍，一方面方便工作交接，自己也方便汇报工作，另一方面方便给自己理清思路，为以后使用这份代码做准备。

**坐姿端正，保护好你的颈椎。** 老程序员都懂，颈椎不好多么影响工作效率。写代码时尽量用大屏，这样不用低头去写，坐姿正确对颈椎、老腰都好，可持续输出才是王道。

![图片][8c7c0d9bfc83c7e71e5174e7f7547e16.png]

**Setup好用的IDE事半功倍。** 我写Python用Pycharm

说下Pycharm使用的一些tips：

**1、用好TODO**

为临时代码使用TODO注释，它是一种短期解决方案。不算完美，但够好了。

TODO注释应该在所有开头处包含”TODO”字符串，后面可以根据个人偏好加上一行注释，解释要做什么之类的。主要目的是为了有一个统一的TODO格式，这样添加注释的人就可以搜索到

# TODO(domi): 优化阈值# TODO(tony) : 调整变量

如果你的TODO是”将来做某事”的形式， 那么请确保你包含了一个指定的日期(“2009年11月解决”)或者一个特定的事件(“等到所有的客户都可以处理XML请求就移除这些代码”)。在你提交代码到GitHub的时候，会提示你的todo内容，方便你查看自己的待做事项

**2、代码设置模板**

在settings->Editor->file and code templates

![图片][8d076d2a82b806d40bd051399b0af843.png]

# !/usr/bin/env python# -*- encoding: utf-8 -*-"""@File   : ${NAME}.py    @Contact: xxxxx@Usage  : @Modify Time        @Author        @Version        @Desciption------------        -------        --------        -----------${DATE} ${TIME}     domi           1.0             None@TODO   :"""

3、习惯Matlab编程的人一开始会很不习惯Pycharm，没法实时查看变量来调试代码，如果想Pycharm查看变量，需要通过Python Console，也可以使用Anaconda的Spyder模块，开发界面和matlab类似，变量实时查看

![图片][8b16e4f3f2bc21daa586324eaef89c13.png]

推荐的Google Style代码规范：

https://zh-google-styleguide.readthedocs.io/en/latest/google-python-styleguide/contents/

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FpbmdmZW5neGQx_size_16_color_FFFFFF_t_70][]

[8c7c0d9bfc83c7e71e5174e7f7547e16.png]: /images/20221024/259d08053acc4dd98e47bdaddda73f70.png
[8d076d2a82b806d40bd051399b0af843.png]: /images/20221024/c53399f6faeb4351b2ed758690004338.png
[8b16e4f3f2bc21daa586324eaef89c13.png]: /images/20221024/92f065eb53d342f181bc767e0ac88bd5.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FpbmdmZW5neGQx_size_16_color_FFFFFF_t_70]: /images/20221024/8877cd6b881d4885816a9aa9f1dced06.png