本公司轻量化程序一般分为控制台程序和插件程序两种,可分别编写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