当前位置: 首页 > 科技观察

程序员讨厌写文档?这4个工具让你事半功倍

时间:2023-03-21 01:01:19 科技观察

对于普通程序员来说,花费数小时创建代码或修改现有代码只是一天的一部分,简而言之,当程序员忙于他们的最新项目时,他们将自己与在外界看来,这种刻板印象是有一定道理的。但是您没有意识到的是,许多程序员实际上需要保留关于他们的代码如何工作的文档。事实上,很多程序员都不愿意写文档。作家兼编程心理学专家杰拉尔德·温伯格将其总结为“编程蓖麻油”——换句话说,这对他们有好处,但他们讨厌这样做。没有好的文档,就缺乏有关的信息软件是如何工作的,现在很多开发者在他们写的代码中留下了一个基本的路线图,这仍然没有解决代码最终用户的问题,因此,软件开发者必须养成良好的文档习惯,让你的黑-box代码对别人来说不会是个谜,今天给大家推荐4款不错的在线软件文档工具:1.GitHubPages现在大部分程序员都用Github这个通用的代码库,所以对于想保存文档的程序员来说,Github是一个不错的选择,虽然很多人只是使用代码库中的readme功能来为项目提供简单的操作指南,但这并不是最好的方式。GitHubpages,它的项目页面(包括文档和手册)provide一个专用的托管平台。它直接与所有GitHub存储库交互,允许开发人员像更新代码一样更新文档。最重要的是,用户可以使用Jekyll将纯文本标记转换为成熟的静态网站,而无需额外的编程。地址:https://pages.github.com/2。ReadtheDocsReadtheDocs顾名思义,ReadtheDocs为开发者提供了一个集中保存文档的平台,让用户可以直接阅读文档。它的工作方式有点像GitHub页面,因为开发人员可以从他们最喜欢的版本控制系统(包括Git、Bazaar、Mercurial等)推送文档更新。然而,ReadtheDocs最好的部分是它的灵活性,因此开发人员可以自动化大部分文档创建过程,这可以节省大量时间,最重要的是,平台上的所有内容都可以多种格式提供。多种格式向公众开放,包括pdf、HTML、电子阅读等。地址:https://readthedocs.org/3。虽然严格来说Tettra并不是一个软件文档平台,但作为一个成熟的知识库,Tettra仍然是一个非常优秀的软件文档工具。当一个项目由多个程序员设计,非技术用户想了解整个项目的细节时,Tettra最适用。对于大多数软件开发人员而言,Tettra擅长记录与其工作相关的常见问题的答案。地址:https://tettra.com/4。Apiary尽管软件文档一直被认为是关键任务,但有一种文档是任何开发人员都不能忽视的——API文档,因为它们是软件中最容易阅读的文档。外部用户发现的部分,因此在不清楚的地方也会产生很多问题。Apiary是一个允许用户使用Markdown编写文档的平台,包括模拟API调用。此外,该平台允许用户测试API,换句话说,它既是一个文档工具,也是一个测试平台。地址:https://apiary.io/