精华内容
下载资源
问答
  • 代码使用说明文档
    千次阅读
    2018-09-28 13:45:54

    java代码规范文档

    原则:

    注释形式统一

    在整个应用程序中,使用具有一致的标点和结构的样式来构造注释。如果在其它项目中发现它们的注释规范与这份文档不同,按照这份规范写代码,不要试图在既成的规范系统中引入新的规范。

    注释内容准确简洁

    内容要简单、明了、含义准确,防止注释的多义性,错误的注释不但无益反而有害。

    注释条件

    基本注释

    1.类(接口)的注释
    2.构造函数的注释
    3.方法的注释
    4.全局变量的注释
    5.字段/属性的注释

    特殊必加注释

    1.典型算法必须有注释
    2.在代码不明晰处必须有注释
    3.在代码修改处加上修改标识注释
    4.在循环和逻辑分支组成的代码中加注释
    5.为他人提供的接口必须加详细注释

    注释格式

    单行(single-line)注释:“//……”
    块(block)注释:“/……/”
    文档注释:“/*……/”
    javadoc 注释标签语法

    @author   对类的说明 标明开发该类模块的作者 
    @version   对类的说明 标明该类模块的版本 
    @see     对类、属性、方法的说明 参考转向,也就是相关主题 
    @param    对方法的说明 对方法中某参数的说明 
    @return   对方法的说明 对方法返回值的说明 
    @exception  对方法的说明 对方法可能抛出的异常进行说明
    

    参考实例

    类(接口)的注释

    /**
     * @Description 类的描述
     * @author Administrator
     * @Time 2018-09-28
     * @version v1.1
     */
    public class testEwallet {
    	
    }
    

    构造函数的注释

        /**
    	 * @Description 构造方法描述
    	 * @param name
    	 * 按钮上显示文字
    	 */
    	public testEwallet(String name){
    	}
    

    方法注释

     /**
    
            * 为按钮添加颜色
    
            * @param color
    
            * 按钮的颜色
    
            * @return 
    
            * @exception  (方法有异常的话加)
    
            * @author Administrator
    
            * @Time2012-11-20 15:02:29
    
            */
    
            public voidaddColor(String color){
            }
    

    全局变量注释

      /** The value is used for characterstorage. */
    
         private final char value[];
    

    字段/属性注释

    
         private String senderName;//发送人姓名
    
         private String title;//不能超过120个中文字符
    
    更多相关内容
  • Doxygen是一个能从带注释的源码中自动生成说明文档的标准工具,它支持众多流行的编程语言,包括C/C++、C#, PHP, Java, Python, IDL 等

    简介

    Doxygen是一个能从带注释的源码中自动生成说明文档的标准工具,它支持众多流行的编程语言,包括C/C++、C#, PHP, Java, Python, IDL 等

    Doxygen能够从以下三个方面进行工作:

    • 从一组源文件中生成HTML格式的在线文档和LETEX格式的离线文档,此外还提供了RTF(MS-Word)、PostScript、超链接 PDF、压缩 HTML 和 Unix等格式输出。

    • 从源码中提取代码结构,通过依赖关系图、继承图和协作图自动生成各种元素之间的关系图。

    • 为用户制作用户手册和网站

      Doxygen可以在Mac OS、Linux和Windows下工作,还可以在大多数其他Unix上运行。

    安装

    Ubuntu下可以直接从apt源进行安装

    sudo apt-get install graphviz
    sudo apt-get install doxygen
    # 带gui的doxygen
    sudo apt-get install doxygen-gui
    

    使用

    你可以使用特定的命令行来生成配置文件手动配置,也可以执行doxywizard在图形化界面中进行配置。在doxygen中,不同工具之间的关系图如下所示

    从命令行生成

    1. 创建配置文件

    doxygen -g <config-file>
    # 或(不含注释)
    doxygen -s -g <config-file>
    

    <config-file>为生成配置文件的名称,如果不输入则默认为Doxyfile,若已存在名为 <config-file>的文件,则会将原先的 <config-file>重命名为 <config-file>.bak。

    2. 修改配置文件

    这里列举出常用的配置选项,关于完整的配置选项说明,可以参考doxygen官网提供的Config-Docs

    项目相关配置
    • DOXYFILE_ENCODING

      指定用于配置文件中所有字符的编码,默认为UTF-8。

    • PROJECT_NAME

      项目名称,默认为 My Project

    • OUTPUT_DIRECTORY

      标记用于指定将生成的文档写入的(相对或绝对)路径。如果输入了相对路径,则该路径将相对于 doxygen 的启动位置。如果留空,将使用当前目录。

    • OUTPUT_LANGUAGE

      标记用于指定编写 doxygen 生成的所有文档的语言。

    构建相关配置
    • EXTRACT_ALL

      如果设置为 YES,则 doxygen 将假定文档中的所有实体都已记录,即使没有可用的文档也是如此。私有类成员和静态文件成员将被隐藏,除非EXTRACT_PRIVATE分别EXTRACT_STATIC标记设置为 YES.

    • EXTRACT_PRIVATE

      如果设置为 YES,则类的所有私有成员都将包含在文档中。

    • EXTRACT_STATIC

      如果设置为 YES,则文件的所有静态成员都将包含在文档中。

    • EXTRACT_LOCAL_CLASSES

      如果设置为 YES,则在源文件中本地定义的类(和结构)将包含在文档中。如果设置为 NO,则仅包括头文件中定义的类。

    与输入文件相关配置
    • INPUT

      标记用于指定包含记录的源文件的文件和/或目录。

    • INPUT_ENCODING

      标记可用于指定 doxygen 解析的源文件的字符编码。

    • RECURSIVE

      指定是否也应搜索子目录以查找输入文件。

    绘图相关配置
    • HAVE_DOT

      是否使用Graphviz图形可视化工具包

    • CALL_GRAPH

      为每个全局函数或类方法生成一个调用依赖图,启用此选项将显着增加运行时间。

    • CALLER_GRAPH

      为每个全局函数或类方法生成调用者依赖图,启用此选项将显着增加运行时间。

    3. 运行doxygen

    doxygen <config-file>
    

    根据您的设置,doxygen 将在输出目录中创建 htmlrtflatexxmlman 和/或 docbook 目录。

    从gui生成

    终端键入doxywizard,打开图形化界面

    doxywizard
    

    配置相关选项,具体可以参考上一部分的选项说明

    生成配置文档

    查看文档

    在html文档中找到index.html,打开即可查看你的专属在线文档!

    后续

     喜欢的话可以关注一下我的公众号技术开发小圈,尤其是对深度学习以及计算机视觉有兴趣的朋友,我会把相关的源码以及更多资料发在上面,希望可以帮助到新入门的大家!
    在这里插入图片描述

    展开全文
  • 有钱的可以考虑(笔者穷逼一个),办理一张软著大概至少需要300+以上(这个价格是淘宝那种才比较便宜,正规点的约600元起,但是建议别去淘宝,你以后要处理其他事务会比较麻烦),而且软件的使用说明和源代码你不...

    前言:笔者自己是一位穷逼的个人开发者。自己开发了一款应用,但上架各大手机应用商店基本上都是需要有软件著作权的。现分享一下我申请的全过程,当然网上申请流程已经烂大街都是了,主要分享的是申请资料

    	申请软件著作权的3种方法
    
    1. 自己网上申请,把所需材料递交给国家版权中心(北京的主中心,和3个分局),其余3个城市分局只是代理收资料而已,他们也是邮寄到北京国家版权中心处理的。(该方法办理不需要任何费用)
    2. 自己网上申请,把所需材料邮寄到北京国家版权中心(费用是你寄到北京的快递费,北京国家版权中心邮寄回来的快递费需不需要你出这个我就不清楚了)。
    3. 通过代理公司办理,但是你经常可以看到说加急多少多少钱,其实版权中心也是有提供这种服务的,不过是额外付费的

    下图是本人自己去深圳国家版权中心拍的,自己办理免费的啊,31-35那个算加急的,不过自己不加急办理也是差不多35个工作日
    在这里插入图片描述

    笔者在深圳这边,过去深圳的分部不远,所以选择了第一种。至于第二种邮寄未曾尝试过,请自行百度吧。至于第三种的话,有钱的可以考虑(笔者穷逼一个),办理一张软著大概至少需要300+以上(这个价格是淘宝那种才比较便宜,正规点的约600元起,但是建议别去淘宝,你以后要处理其他事务会比较麻烦),而且软件的使用说明和源代码你不提供的话,还得叫人撰写至少也要100+。还有人家代理公司办理的速度也是和你自己办理的速度一样的。

    	教程开始
    

    http://www.ccopyright.com.cn/ 这个地方注册一下账号
    首页的 我要登记 —> 软件登记
    在这里插入图片描述
    进入个人中心后,在左侧下方的在线业务中选择“我要登记”,然后再选择“R11.计算机软件著作权登记申请”
    在这里插入图片描述
    填写资料可以看看我的
    在这里插入图片描述
    在这里插入图片描述
    在这里插入图片描述
    至于网上填写申请最后一项,按照默认的就可以了,一般交存—>一种文档…例外交存那里不用理会
    在这里插入图片描述
    在这里插入图片描述
    上面只需要填写4处,其他的不用理会

    当然我讲的不是很详细,要详细的可以考虑去看这篇文章https://blog.csdn.net/cmqwan/article/details/82856206
    当然说说资料,先看看我去版权大厅拍的,当然你看一下参考一下就行了,具体的看下来
    在这里插入图片描述
    上面别太当真,不然你会很乱,你只需要准备下面材料就行了,或者拿我的资料去改改

    1. 身份证复印件
    2. 说明书一份16+张(我自己写了24张,这玩意你看我附件就知道了,很容易的)
    3. 软件著作权申请表一份4张(就是你刚才在网上填写的申请表,打印出来就行了,好像第四张要签名。注意这里有一个坑,看下面)
    4. 源程序一份61张(这种直接那我的资料,然后把第一页的软件名称改掉,和每一页的页头的软件名称改掉就可以了)

    4张申请表的注意事项
    每一页的页头最上面必须是流水号(条纹码),因为他的打印真的很怪,打印出来出现下面这张的错误情况
    在这里插入图片描述

    上面是错误的,下面才是正确的,4张每一张的流水号都在最上面(每一张的最上面只能是流水号,不能出现上一页的内容),而且底下不能出现下一页的内容

    在这里插入图片描述

    我申请的流程状态

    在这里插入图片描述
    12月30号那天办理的,然后到现在2月24号拿到手,一共两个月24天,而且快递也慢(应该也是疫情影响的),不然更快。整体还算满意吧,毕竟新年,元宵,还有疫情影响都不知道他们休了多少天。
    给你们大概看一些源代码资料和软件说明资料的截图

    软件使用说明的大致截图

    在这里插入图片描述
    在这里插入图片描述
    在这里插入图片描述
    在这里插入图片描述

    源代码截图

    在这里插入图片描述
    例外,文件原本是我取用https://blog.csdn.net/cmqwan/article/details/82856206该链接里面的提供素材进行修改的,也感谢原作者 cmqwan

    文档下载地【免费】https://download.csdn.net/download/qq_23064433/12188550
    链接:https://pan.baidu.com/s/1oR7FhSJtME1xhrYKrAEGaA
    提取码:y70o

    本人邮箱,真有需要的可以发来问问,但别骚扰我 2309680188@qq.com

    在这里插入图片描述
    上图是我传递之后的所有状态,你们可以参考一下,2月13号过后不久我就收到快递了

    2020/07/03 更新说明
    如果有公司建议使用软著著作权人为公司的,要不然在以后上架到应用商店时,如果你的应用商店认证是你的公司,但是软著著作权人又是个人的话,有些应用商店还有要求你写一个公司和著作权人的授权说明书,至于公司的怎么申请,可以去翻翻下面的评论
    2020/10/16 更新说明
    去分局的话是需要预约的,在微信公众号里面预约,《中国版权服务》底部导航->微平台->后续操作我就记不清了。

    另外说明,该文章很有可能会被其他网站转载,导致你找不到评论,原贴在csdn(根据标题搜索)

    展开全文
  • C#ListView自定义控件(重绘)代码+说明文档 C#中的listView很不强大
  • 项目开发中如何写说明文档

    万次阅读 2017-11-21 18:44:11
    叫你怎么写开发文档:步骤描述:步骤描述需要一定的逻辑性。但不一定是纯文字形式,可以用公式,便于理解的伪代码+文字等方式进行步骤描述

    第一节 总流程
    一、(原理介绍)
    XXXXXXXXXXXXXXXXXX
    二、(总的流程图)

    第二节:主接口1
    一、(原理介绍)
    XXXXXXXXXXXXXXXXXXXXXXXXX
    二、(总的流程图)

    例子:
    流程图
    这里写图片描述

    步骤描述:步骤描述需要一定的逻辑性。但不一定是纯文字形式,可以用公式,便于理解的伪代码+文字等方式进行步骤描述
    这里写图片描述
    这里写图片描述
    这里写图片描述

    这里写图片描述
    这里写图片描述

    三、分模块介绍
    1、逻辑模块一:
    1.1 代码
    1.2 流程图
    1.3 详细说明

    例子:
    1、 三个框相交,则去掉中间的
    这里写图片描述
    这里写图片描述

    1.  if(detectResult.size() > 1)  
    2.      for(int i=1;i<detectResult.size()-1;i++){  
    3.          if (((detectResult[i].x + detectResult[i].width + 2) >= detectResult[i + 1].x) &&  
    4.              (detectResult[i].x <= (detectResult[i - 1].x + detectResult[i - 1].width - 2))){  
    5.          }  
    6.          if (((detectResult[i].x + detectResult[i].width + 2) >= detectResult[i + 1].x) &&  
    7.              (detectResult[i].x <= (detectResult[i - 1].x + detectResult[i - 1].width - 2))  
    8.              && ((detectResult[i + 1].x - detectResult[i - 1].x - detectResult[i - 1].width) < (0.7*(ROIWIDTH + avg_distance_of_chars)))){  
    9.              detectResult.erase(detectResult.begin() + i);  
    10.             i--;  
    11.         }                     
    12.     }
    

    2、接口模块:
    2.1 代码
    2.2 功能描述
    2.3 接口描述
    2.4 核心原理

    例子1:
    以cifar-10为例说明,具体的运算过程,对应代码:
    这里写图片描述
    1、卷积:
    1.

    inline void Conv(const int *restrict pSrc, int *restrict pDst, const int *restrict pKer, const int input_w, const int input_h, int k_size, int stride)  
    2.  {  
    3.      int   y, i, j, k;  
    4.      int tSum;  
    5.      const int *pSS = pSrc;  
    6.    
    7.    
    8.      for (y = 0; y< (input_h + stride - 1) - k_size + 1; y += stride, pSS += (stride*input_w))  
    9.      {  
    10.         for (i = 0; i<(input_w + stride - 1) - k_size + 1; i += stride)  
    11.         {  
    12.             tSum = 0;  
    13.             for (j = 0; j<k_size; j++)  
    14.             {  
    15.                 for (k = 0; k<k_size; k++)  
    16.                 {  
    17.                     tSum += pSS[j * input_w + i + k] * pKer[j * k_size + k];                      
    18.                 }  
    19.             }  
    20.   
    21.             *pDst++ = tSum;   
    22.         }  
    23.     }  
    24. }  

    1.1 功能描述
    宽为input_w、高为input_h的输入图像pSrc,与k_size x k_size的卷积核pKer进行卷积,得到宽为input_w、高为input_h特征图pDst。

    1.2 接口描述
    这里写图片描述

    名称  In/out/Par  Size/precision  Description/value
    pSrc    in  input_w* input_h    输入图像
    pDst    out input_w* input_h    输出图像
    pKer    in  k_size * k_size 卷积核
    input_w parameter   int 输入图像宽
    input_h parameter   int 输入图像高
    k_size  parameter   int 卷积核宽,一般为奇数
    stride  parameter   int 卷积核在图像上上下左右滑动的平移像素幅度

    1.3 核心原理(以cifar-10为例进行说明):
    (1)输入是3个32*32, 共3*1024=3072。每条边padding为2,则内存里实际为3个36*36.
    (2)卷积核个数是3维的5*5分别与3个输入进行卷积运算,得到3维的32*32的输出,这里将3维的32*32对应位相加得到一张32*32的feature Map
    (3)输出:如果有64个3维的5*5卷积核就有64张feature Map
    具体过程图示为:
    这里写图片描述
    卷积的权值读取方式为:
    (1)第1个5*5作用于第一张输入全图,
    (2)第2个5*5作用于第二张输入全图,
    (3)第3个5*5作用于第三张输入全图,
    (4)再把这三个对应位置相加,在加上biases,得到第一张feature map
    (5)最后64个5*5*3重复上面的过程,得到64个featuremap
    (6)这里weights有3*5*5*64个,biases有64个.
    这里输入是3 个图像,输出是64个特征图,卷积核是5*5权值个数是64* 5*5*3

    例子2:

    这里写图片描述

    展开全文
  • 图像配准matlab源代码(里面有说明文档

    千次下载 热门讨论 2011-07-29 11:15:14
    图像配准matlab源代码,matlab7测试过,结果不是那种两幅图像之间的连线,而是轮廓图,具体还没看程序,先发给大家,又想看的自己搞懂,里面有说明文档,感觉原作者蛮认真的
  • STM32F4官方库帮助文档,库函数说明

    热门讨论 2014-02-26 14:08:13
    STM32F4官方库帮助文档,并配有库函数的说明,举例。 还包含官方库示例代码,对用官方库可起到迅速开发的作用。
  • 其实,标准规范里,python代码写完都要进行规范性测试。 比如: black . # 帮你添加空格,看起来好看 flake8 # 检查不规范的地方 然后会检查出代码不规范的地方,进而修改,比如下面这样的 ✨ 1. python dostring...
  • (1)这里如果报如下错的话,使用notepad++将编码格式改成ANSI编码(改编码格式之前先复制好代码) (2)必须将类设置为public格式,因此类名和文件名必须一样,否则报如下错误 5、调用javad.
  • javaEE大作业 网上考试系统设计(代码、报告、使用说明)本人软件工程学生 此套代码文档保证正确、完善、成绩优异。只许导入、读懂(难度适中、注释详细)修改姓名、学号等信息,就能使用。祝您考试顺利、学习进步、...
  • LayUI使用文档

    千次阅读 2020-10-19 12:42:16
    代码,sort为开启排序 3.2 接收参数 page和limit 模拟 页面:改成对应的参数,页码数可以自定义 也可以自己建一个类替代上面的map 四、上面默认都是异步,使用thymeleaf注意 表头格式和thymeleaf里的[[]]用法冲突了 ...
  • SkeyePlayer插件使用说明文档

    千次阅读 2017-11-27 18:08:39
    两种插件均包含源码,由于FireBreath框架生成代码比较多,npAPI插件只包含关键代码,后续会提供专门讲解FireBreath生成SkeyePlayer npAPI插件的文档,下面我们开始讲解两种插件如何使用。 ActiveX OCX控件 ActiveX...
  • uniapp中使用colorUI说明文档

    万次阅读 2020-03-30 09:32:35
    ColorUI迎来了2.0的升级,相比之前的版本,2.0版本重构了基础代码,增加了更多的配色,这是一个全新的小程序UI解决方案。 ColorUI是一个Css类的UI组件库!不是一个Js框架。相比于同类小程序组件库,ColorUI更注重...
  • 如何写一个代码分析文档

    千次阅读 2018-11-08 01:16:23
    4.具体代码说明 5.总结 1.给出这段代码的功能描述,让读者知道这篇文章主要介绍哪一部分 2.这段代码入口方法,以及如何找到入口类、方法 3.给出结论的代码调用图 (1)跟那些组件有交互 (2)跟哪些关键类...
  • 快速将代码源码全部复制到word文档

    万次阅读 热门讨论 2019-07-25 17:57:44
    下载到本地,Copy到Word文档中 简单说明: find . -name '*.java' -o -name '*.ftl' //查找当前目录以及子目录中以java或者ftl结尾的文件 find . -name '*.java' -o -name '*.ftl' | xargs cat //将代码...
  • 软著申请60页的源代码文档在线生成工具

    千次阅读 热门讨论 2021-01-12 11:46:43
    软著申请60页的源代码文档在线生成工具 1.首先访问网站https://ruanzhu.51lookup.top/ 2.在对应的软件名称版本号和公司名称处填写,此处主要设置的就是word中的页眉和页脚。 3.将有效源代码整理到一个文件夹...
  • 通用WEB项目DEMO说明文档

    千次阅读 2018-11-02 16:39:40
    通用WEB项目DEMO说明文档通用WEB项目DEMO说明文档项目结构说明遵循原则:约定大于规范混淆说明后端代码开发文件结构约定Mybatis自动生成properties文件参数引入AOP处理日志打印异常处理common包代码关于对外接口前端...
  • http://www.tuicool.com/articles/RRNNf2http://www.cnblogs.com/net515/p/3311584.html
  • 这里大概有三四十个字段,如果一个的对着接口文档来写异常耗时,就是个苦力活,那有没有什么办法可以实现快速生成这种简单的代码呢?我们的接口文档用的是Swagger 可以看到其实接口文档上对应的中文名和字段都是有...
  • c++代码文档化注释

    千次阅读 2018-10-10 14:42:29
    近段时间,一直在学习华为C语言编程规范...在使用过程中,我已经深深地喜欢Doxygen,并在写代码使用Javadoc注释风格。  本文由三部分组成:1)工具下载及安装;2)编写Doxygen可识别的注释;3)利用Doxygen工具将...
  • 在线接口文档管理工具(小幺鸡)使用说明前言小幺鸡的地址:http://www.xiaoyaoji.cn/几大看点:在线接口测试; 可视化编辑与分享; 代码开源。可以离线部署。
  • 软件著作权申报中60页标准代码文档的写作经验谈(1) 在申报著作权的工作中,都要提供软件的60页源代码。这是一种特殊要求的东西,它要求每页50行程序,并要求前30页是程序的前半部分有开头并连续,后30页是程序的...
  • 完整的酒店餐饮管理系统源代码包括开发文档

    千次下载 热门讨论 2012-09-25 17:10:13
    完整的酒店餐饮管理系统源代码包括开发文档
  • Qt帮助文档使用方法

    千次阅读 2019-10-22 20:22:18
    Qt 帮助文档非常细致而全面,应有尽有,是非常不错的自学教材...本节介绍 Qt 助手和 Qt 帮助文档使用,学会基本的文档运用方式。 Qt Assistant(Qt 助手) 在开始菜单中找到“Qt 5.9.0-->5.9-->MinGW 5.3....
  • python_docx制作word文档详细使用说明

    万次阅读 多人点赞 2018-06-18 17:56:58
    目前网上对这一个库的介绍得很少,很零散,所以很多功能我是尽量参考其官网,但是官网上面很多功能目前只有说明文档,而代码并还没有即使更新,以至于按照官网上面做了,python去报错了。比如:自定义表格的高度。...
  • 2022跨年代码(有烟花)

    万次阅读 多人点赞 2021-02-09 19:54:45
    马上就要到春节了,于是写了一个跨年倒计时代码,祝大家在新的一年里:所念的人平安喜乐,所想的事顺心如意。 代码: <!doctype html> <html> <head> <meta charset="utf-8"> <title>...
  • 变频器详细代码,原理图,PCB文件,有详细的硬件设计说明和软件设计说明文档。 方案基于STM32,设计文档详细。 :34399634499958928奋进的贝贝贝
  • 申请计算机软件著作权(以下简称“软著”),一共要提交四份文件:身份证明,设计代码,申请表,软件使用(设计)说明文档。 前三个已经介绍过了,所以这篇博客就来讲如何撰写软件使用说明书。 ——————————...
  • 如何写好一份软件开发设计文档

    千次阅读 2021-10-21 16:06:06
    设计文档- 也被称作技术规范和实现手册,描述了你如何去解决一个问题,是确保正确完成工作最有用的工具,其目的是迫使你对设计展开缜密的思考,并收集他人的反馈,进而完善你的想法,同时在软件交付和交接的过程中,...

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 1,004,095
精华内容 401,638
关键字:

代码使用说明文档