软件开发目录规范

一 软件开发目录规范

    - bin
        - start --> 启动软件入口

    - conf
        - settings.py   配置文件
            - 比如存放一些固定的路径
    
    - core
        - src 核心业务逻辑代码
    
    - db  ---> 用于存放数据文件与操作数据的代码文件
        - db_file ---> db.txt ...
    
        - db_handler.py ---> 操作数据的代码
    
    - lib
        - common: 存放公共的功能
            - 比如存放 装饰器
    
    - log
        - log.txt  存放日志的文件

二 一个项目开发前,有一份开发文档

项目: 编写小说阅读程序实现下属功能

     一:程序运行开始时显示
        0 账号注册
        1 账号登录
        2 充值功能
        3 阅读小说


     二: 针对文件db.txt,内容格式为:"用户名:密码:金额",完成下述功能
        2.1、账号注册
        2.2、账号登录
        2.3、充值功能

     三:文件story_class.txt存放类别与小说文件路径,如下,读出来后可用eval反解出字典
        {
            "0":{
                "0":["倚天屠狗记.txt",3],
                "1":["沙雕英雄转.txt",10]
            },
            "1":{
                "0":["令人羞耻的爱.txt",6],
                "1":["二狗的妻子与大草原的故事.txt",5]
            },

        }

        3.1、用户登录成功后显示如下内容,根据用户选择,显示对应品类的小说编号、小说名字、以及小说的价格
        """
        0 玄幻武侠
        1 都市爱情
        2 高效养猪36技
        """

        3.2、用户输入具体的小说编号,提示是否付费,用户输入y确定后,扣费并显示小说内容,如果余额不足则提示余额不足

     四:为功能2.2、3.1、3.2编写认证功能装饰器,要求必须登录后才能执行操作

     五:为功能2.2、3.2编写记录日志的装饰器,日志格式为:"时间 用户名 操作(充值or消费) 金额"

1、软件定位,软件的基本功能;

2、运行代码的方法: 安装环境、启动命令等;

3、简要的使用说明;

4、代码目录结构说明,更详细点可以说明软件的基本原理;

5、常见问题说明。

posted @ 2020-03-28 15:30  小子,你摊上事了  阅读(133)  评论(0)    收藏  举报