杂谈八股文：怎样写好项目代码的说明书

背景：一直以来，我们对编写代码文档不够重视，认为不重要，甚至是没有必要的，就算有文档，写的也是风格各异。在这里，我谈谈个人的一点看法，并用markdown写了一个范例，可以参考！

 

即然以八股文为例，就需要一个大纲，我个人的建议如下：

一、这是什么：要求通俗易懂
二、这有什么意义：要求通俗易懂
三、这怎么使用：要求步骤详细、通俗易懂

 

上面的这，替换成自己的项目实际名字就行。

 

我个人认为，项目的代码说明书，可以参考这个结构写，不需要长篇大论，也不会浪费很多时间，最主要的是：不但帮我们整理了项目的思路，还降低了使用成本和维护成本，和收益比，花点时间写好说明书，是非常必要的。

 

python操作flask

flask是什么

略

flask有什么用

略

flask怎么用

看下面的步骤

新建flask项目

mkdir flask_demo
cd flask_demo

安装flask

pip install flask

新建app.py

请参考app.py的例子和flask官网文档自行扩展

from flask import Flask

app = Flask(__name__)

@app.route('/')
def index():
    return 'index'

if __name__ == '__main__':
    app.run()

配置flask热重载，有2种方法，推荐第2种

1 在app.py加上下面的代码：

app.run(debug=True, use_reloader=True)

2 在命令行加上下面的代码：

export FLASK_APP=app.py # Mac环境可忽略此命令，Windows环境请自行测试
flask run --reload

使用flask

来到本例中app.py所在的根目录

如果在app.py按方法1配置了flask热重载，执行下面的命令：

flask run

如果没有配置flask热重载，执行下面的命令：

flask run --reload