基于Sphinx的安全测试脚本文档生成方案
|
摘要
论文分析了网络安全工作中创建优质的网络安全测试脚本文档的必要性,对Docstring编写风格进行了介绍,并对Sphinx文档生成系统和reStructuredText标记语言进行了说明。同时,提出了一种基于Sphinx的网络安全测试脚本文档生成方案,利用Sphinx的第三方扩展、对内建注释工具的有效利用、对注释字段的针对性扩充,使生成注释文档更加清晰、规范,切合网络安全人员使用代码的实际需求,有效地提高了测试代码的可维护性和复用效率。
In this paper, the necessity of a high quality network security test script documentation is analyzed. The documenting styles of Python's docstring are introduced, as well as the Sphinx documentation creation tool and the reStructuredText scripting language. A method of network security test script documentation creation based on Sphinx is proposed. This method makes use of third party extensions, making effective utilization of built-in documenting functionalities, and extending specific field lists, which effectively improves the clearness and normativity of documentation. This method fits in with the requirement of security testers in code processing, increasing the test script's maintainability and reuse efficiency.
In this paper, the necessity of a high quality network security test script documentation is analyzed. The documenting styles of Python's docstring are introduced, as well as the Sphinx documentation creation tool and the reStructuredText scripting language. A method of network security test script documentation creation based on Sphinx is proposed. This method makes use of third party extensions, making effective utilization of built-in documenting functionalities, and extending specific field lists, which effectively improves the clearness and normativity of documentation. This method fits in with the requirement of security testers in code processing, increasing the test script's maintainability and reuse efficiency.
引文
[1]Steidl D,Hummel B,Juergens E.Quality analysis of source code comments[J].2013 IEEE 21st International Conference on Program Comprehension(ICPC).2013.
[2]Khamis N,Witte R,Rilling J.Automatic quality assessment of source code comments:the Javadoc Miner[C].Natural Language Processing and Information Systems.2010.
[3]高晓伟,杜晶,王青.源代码分析注释的质量评价框架[J].计算机系统应用,2015,24(10):1-8.
[4]陈琪,葛志松,许骏龙.软件文档质量评价方法研究[J].电脑知识与技术,2018,14(30):60-61+69.
[5]沈力,刘洪星,李勇华.基于版本控制的中文文档到代码跟踪方法[J/OL].计算机应用:1-6[2019-02-27].
[6]霍福华.强化计算机软件文档质量监督的探讨[J].河北软件职业技术学院学报,2018,20(1):7-9.
[7]黄袁,贾楠,周强,陈湘萍,熊英飞,罗笑南.融合结构与语义特征的代码注释决策支持方法[J].软件学报,2018,29(8):2226-2242.
[8]余海,李斌,王培霞,贾荻,王永吉.基于组合分类算法的源代码注释质量评估方法[J].计算机应用,2016,36(12):3448-3453+3467.
[9]Fluri B,Wursch M,Gall HC.Do code and comments co-evolve?On the relation between source code and comment changes[C].14th Working Conference on Reverse Engineering,WCRE 2007.IEEE.2007:70-79.
[2]Khamis N,Witte R,Rilling J.Automatic quality assessment of source code comments:the Javadoc Miner[C].Natural Language Processing and Information Systems.2010.
[3]高晓伟,杜晶,王青.源代码分析注释的质量评价框架[J].计算机系统应用,2015,24(10):1-8.
[4]陈琪,葛志松,许骏龙.软件文档质量评价方法研究[J].电脑知识与技术,2018,14(30):60-61+69.
[5]沈力,刘洪星,李勇华.基于版本控制的中文文档到代码跟踪方法[J/OL].计算机应用:1-6[2019-02-27].
[6]霍福华.强化计算机软件文档质量监督的探讨[J].河北软件职业技术学院学报,2018,20(1):7-9.
[7]黄袁,贾楠,周强,陈湘萍,熊英飞,罗笑南.融合结构与语义特征的代码注释决策支持方法[J].软件学报,2018,29(8):2226-2242.
[8]余海,李斌,王培霞,贾荻,王永吉.基于组合分类算法的源代码注释质量评估方法[J].计算机应用,2016,36(12):3448-3453+3467.
[9]Fluri B,Wursch M,Gall HC.Do code and comments co-evolve?On the relation between source code and comment changes[C].14th Working Conference on Reverse Engineering,WCRE 2007.IEEE.2007:70-79.