VScode+AsciiDoc+drawio+PlantUML:技术文档高效编写指南
创始人
2025-01-11 05:18:10
0 次浏览
0 评论
使用VScode+AsciiDoc+drawio+PlantUML设计文档真香
撰写技术文档时如何利用技术手段提高效率?让我们来看看这个伟大的组合:VScode+AsciiDoc+drawio+PlantUML来改善您的文档编写体验。首先,VScode作为开发者的首选工具,以其丰富的代码编辑功能而著称,其插件生态涵盖几乎所有语言开发,是前端开发的得力助手。
它不仅是一个开发环境,更是对文档编辑的有力支持。
接下来是AsciiDoc,Java社区广泛使用的一种文档格式,其语法与Markdown类似,但功能更全面。
尽管可能需要一些学习才能上手,但它支持其原生功能,例如作者信息、版本管理、时间表等。
使文档写作变得更容易。
特别提醒:导出PDF时可能会遇到乱码,需要调整VScode插件和字体设置,比如使用AsciiDoc主题下的字体方案。
与Markdown相比,AsciiDoc似乎是一个更精简、更强大的替代方案。
它不需要额外学习HTML扩展,可以直接满足大多数文档创建需求。
例如,您可以直接在AsciiDoc中添加自定义块和文档引用,以提高编写效率。
draw.io是一款在线流程图绘制工具,无需安装即可在浏览器中使用。
它支持各种类型的图表,包括流程图、软件图等,甚至可以通过VScode插件直接在编辑器中操作,非常方便。
虽然在线版本可能有点慢,但灵活性令人惊叹。
对于需要高级图的场景,例如UML图,PlantUML是最佳选择。
支持UML之外的编码绘图,使图形设计更加专业。
您可以通过ChinaPlantUML的官方网站获得更详细的信息。
总之,这种结合——在VScode中编写AsciiDoc文档,结合drawio进行绘图,以及PlantUML图形支持,无疑为编写技术文档增加了极大的便利。
您可以在github.com/hangheng/As...找到相关源代码示例,开始您的高效文档之旅。
java操作word的有哪几种方式
在Java中读取Word文档时,有很多插件可供选择,例如POI、java2Word、jacob、itext等。POI虽然功能强大,但无法直接读取格式。
新的API还处于研发阶段,不够稳定,所以不敢在项目中轻易尝试。
java2Word和jacob很容易出现找不到注册的问题。
我在不同机器上测试的时候,同样的操作有时会报错,有时又顺利。
即使我在论坛上寻求帮助。
我无法找到根本原因。
当用于项目部署时,这似乎不够可靠。
虽然itext对于编写文档很有用,但阅读它的信息并不多,这使得它在实际应用中成为一个更谨慎的选择。
经过一番考虑,我最终决定使用rtf格式作为读取和创建文档的方式。
rtf格式是一种开源格式,不需要使用任何插件。
它只需要简单的I/O和编码转换。
RTF文件与doc文件类似,可以用Word打开并安装为多种格式。
实现的功能是读取RTF模板中的固定内容和可变内容,替换变化的部分,创建一个新的RTF文档。
实现该功能的具体步骤如下:首先,将固定的部分手动输入到模板中,并使用“$info$”指定需要替换的部分。
然后以字节形式读取RTF模板的内容,并将可变内容字符串转换为RTF编码。
最后,替换源文本的可变部分以创建新的RTF文档。
下面是一个实现上述功能的简单示例程序:publicStringbin2hex(Stringbin){char[]digital="0123456789ABCDEF".toCharArray();StringBuffersb=newStringBuffer();byte[]bs=bin.getBytes();intbit;for(inti=0;i
javaapi接口文档怎么编写?
Java语言提供了一种强大的注释形式:文档注释。
源代码中的文档注释可以提取到系统API文档中。
开发时定义类和方法时,我们可以先添加文档注释,然后使用javadoc工具创建自己的API文档。
文档注释以斜杠开头,后跟两个星号(/**),以星号后跟斜杠(*/)结束。
API文档。
自己搜索javadoc就可以了。
例如:
1234567891011121314151617181920212223242526272829/***类描述**@authorauthor*@version*/publicclassDemoClass{/***内部属性:name*/PrivateStringnai;/***Setter方法*@returnname*/publicStringgetName(){returnname;}/***Getter方法*@paramname*/publicvoidsetName(Stringname){this.name=name;
java工程师的个人简历
简历求职意向职位适用:软件工程师工作经历曾在XX公司担任Java软件开发工程师,负责程序编码、代码测试、技术文档编写、项目问题管理和代码质量监控,以及对团队中开发人员的技术培训。辞职寻求更高的发展机会。
教育背景:毕业于xx学院软件技术专业,获得大专学历。
参加xx培训机构Java程序员培训。
工作能力掌握J2SE、J2EE、Web编程,精通Jsp、Servlet、EL、jstl、xml、JDBC,熟悉Hibernate、spring、struts1和2、Lucene,精通Html、DIV/CSS、JavaScript、jQuery、json、ajax、DWR,熟悉MVC、DAO、IOC、AOP等设计模式。
熟悉WebLogic、tomcat服务器,使用Java集成开发环境Eclipse、MyEclipse、Editplus进行开发,熟练使用mysql、Oracle、SqlServer数据库,掌握SVN版本控制、sqldeveloper、Eclipse、MyEclipse。
主要项目经历1.Web办公自动化管理系统(WebOA):负责组织管理模块和权限管理模块的开发,使用WindowsXP、JDK1.6、Tomcat6.0,版本控制为SVN,主要技术为Struts1、Spring、Hibernate、HTML、JavaScript、DWR,数据库为MySQL,开发工具为MyEclipse8.5。
2、商品交易系统:负责产品后台管理、产品前端展示、产品全文搜索、购物车功能开发,使用WindowsXP、JDK1.6、Tomcat6.0,版本控制为SVN,主要技术为Struts1、Spring、Hibernate、HTML、JavaScript、AJAX,数据库为MySQL,开发工具为MyEclipse8.5。
获奖经历:荣获“xx”全国软件专业设计开发大赛xx赛区Java软件开发高职院校组一等奖第3名、第十五届Java软件开发高职院校组二等奖在全国总决赛中。
相关文章
Java工程师必读:35年经验总结的8大...
2024-12-17 11:12:43Java编程题解析:学生班级与立方体、学...
2024-12-15 03:05:26Python编程:一探究竟,1到100间...
2024-12-14 21:11:25Python教程:100以内质数的查找方...
2024-12-30 02:20:35Java编程思想第9版核心电子书PDF免...
2024-12-16 06:50:14经典Java手游大盘点:重温儿时回忆,解...
2024-12-21 10:58:11、<br>JavaBus新入...
2024-12-21 01:33:12Java双精度转字符串方法解析与Exce...
2024-12-15 07:05:14C语言科学计数法使用详解及示例
2024-12-26 13:48:45千峰教育:专业Java培训,助力IT梦想...
2024-12-15 08:51:24最新文章
13
2025-01
13
2025-01
13
2025-01
13
2025-01
13
2025-01
13
2025-01
13
2025-01
13
2025-01
13
2025-01
13
2025-01
热门文章
1
Java字符串分割技巧:轻松获取逗号前的...
java任意一个字符串,当它碰到第一个逗号时,返回逗号前面的字符串,例如:str...
2
SQL多表连接查询全解析:JOIN语句应...
sql多表关联查询在执行SQL多表连接查询时,可以使用JOIN语句将多个表连接在...
3
Java中字符串类型详解:String与...
变量有字符类型,为什么没有字符串类型??基本类型:charshort、int、l...
4
JavaSE与JavaEE:从基础到企业...
javase 和javaee的区别?JavaSE和JavaEE...
5
Java程序员面试必知:核心技术问答与技...
java编程程序员技术面试常见面试?随着互联网的不断发展,Java开发已经成为很...
6
Java.exe与Javaw.exe:区...
程序中java和javaw有什么区别java和javaw的区别:两者都是Java...
7
深入解析:Java中的javax包及其与...
JAVA导入时,什么是javax?awt是java1.0,swing是java2...
8
Java包基础:命名空间与代码组织指南
java中的包是什么意思?包是Java中组织代码的基本结构。这种结构可以帮助我们...
9
Java AWT与Swing:全面解析二...
java.awt和javax.swing有什么区别AWT是AbstractWin...
10
Java字符串比较:如何检测子字符串在另...
java怎样判断一个字符串中的某个字符或字符串包含于另一个字符串publiccl...