README.md文档编写

本公司轻量化程序一般分为控制台程序和插件程序两种,可分别编写md文件,命名为:README.md和README_ADDIN.md。其中参考内容模型为:

1:README.md

# XXX

#### 调用方法及参数
XXX

#### 环境依赖
1:.Net Framework 4.7 https://www.microsoft.com/net/download/thank-you/net47  
2:需要安装XXX(2017-2021)其中一款或多款软件。

#### 部署安装
1:用条件编译方式编译支持多版本。
XXX


#### 目录结构描述
 
XXX
    
        

2:README_ADDIN.md

# XXX


#### 环境依赖
1:.Net Framework 4.7 https://www.microsoft.com/net/download/thank-you/net47  
2:需要安装XXX(2017-2021)其中一款或多款软件。

#### 部署安装
1:用条件编译方式编译NavToObjAddinPlugin项目支持多版本。
2:编译卸载程序NavToObjUnInstall。
XXX


#### 目录结构描述
 

XXX

具体README.md文档编写 ,可参考以下博客:README.md文档编写 - yeshenmeng - 博客园文章参考自:如何为开发项目编写规范的README文件(windows),此文详解 - 战争热诚 - 博客园 (cnblogs.com) 为什么要写这篇博客? 其实我是一个入坑已经半年的程序员,因为不是https://www.cnblogs.com/yeshenmeng/p/15380687.html

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值