Questions tagged [documentation]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

Filter by
Sorted by
Tagged with
0 投票
1 回答
4432 浏览

如何拥有多个 Doxyfile?

我正在开发一个包含其他 3rd 方库的项目。所有这些第 3 方库都带有自己的 Doxyfile,并且每个库都有自己特定的“图像”文件夹。不幸的是,其中一些库使用相同的命名约定来命名图像。

由于这个原因,如果我为整个源代码树(包括 3rd 方库)生成文档,由于图像名称冲突,它会变得不明确,并且包含来自错误文件夹的图像。

如何使用多个 Doxygen 文件,让每个库都有自己的沙箱?最后,整个文档输出可以以某种方式相互关联吗?

0 投票
6 回答
402 浏览

对操作系统中使用的“系统调用”机制有很好的描述吗?

我正在寻找系统调用机制的良好入门或技术描述,操作系统使用该机制从用户空间转换到内核以调用诸如“打开”、“读取”、“写入”等函数......

除了维基百科条目之外还有其他内容吗?欢迎使用网站、pdf、书籍、源代码 :)

0 投票
1 回答
1435 浏览

能否以编程方式从 Visual Studio 2008 导出类图?

我可以通过右键单击表面并选择“将图表导出为图像...”从 Visual Studio 中将类图导出为图像

有没有办法通过命令行来做到这一点?我希望能够将我所有的类图生成为图像,这样我就可以将它包含在我正在使用 Sandcastle 构建的 .chm 中。

0 投票
4 回答
848 浏览

关闭一个项目——关键的事情是什么?

看来我们的客户很可能会取消我们已经工作了 15 个月的项目。

它有可能(尽管不太可能)会在某个时候重新启动。

在此过程中,我们还在多个领域扩展了我们公司的产品。其他项目团队可能需要进行类似的扩展,我们希望他们能够利用我们所做的。

那么,要为后代记录哪些关键内容,以便未来的团队(可能包括不同的人员)可以从我们所做的事情中学习?

这与为未来的维护者记录的内容略有不同,因为人们到达时可能对我们的项目很少/不熟悉,并且可能不会有任何扩展参与。

到目前为止,我们一直致力于收集有关每个主要功能/扩展的信息——因此有一个地方可以查找需求、指向源代码的指针、测试用例等,并正在添加一些关于关键设计点/决策等的叙述。

当项目团队仍然在一起时,我们还应该做什么和捕捉什么?

0 投票
1 回答
302 浏览

在 Rails 中记录部分参数

是否有任何标准或新兴标准来记录可以传递给 Rails 部分的参数?

_my_partial.html.erb期望 atitleelements通过 传递的本地 var 时render 'my_partial', title: t, elements: e,必须有一种通用的方法来记录它们的名称、期望的类型和角色,而无需阅读整个部分代码。诸如 RDoc 或 Tomdoc 之类的方法和类。没有吗?

编辑:我发现了一个帖子,其作者主张<% var ||= 'default_val' %>在部分的第一行初始化参数,这确实是一种安全的做法和一种代码内文档。真的没有评论/参数声明解决方案吗?

0 投票
1 回答
65 浏览

在代码上记录的必要项目是什么?

每种编程语言都有很多选项,可以在代码文档中提到。

我想知道我们必须记录的最重要的项目是什么?

0 投票
2 回答
346 浏览

在 rdoc 中显示继承的方法

我有一个用 Ruby 编写的程序,它使用多级继承。所有父类都实现了子类对象将使用的方法,但是当我为我的程序生成 rdoc 时,子类的 rdoc 页面仅显示该特定类的方法,而没有来自父类的方法.

有谁知道如何在 rdoc 中显示继承的类方法?我查看了 rdoc 文档和一些网站,但无法找到关于这是否可能的答案。

0 投票
2 回答
479 浏览

Fortran 函数、模块和子例程的自动文档

有没有像Javadoc这样的用于记录 Fortran 代码的东西?如何为他们拥有的许多功能记录 API,以便他们可以更轻松地找到他们想要的东西?

0 投票
4 回答
568 浏览

Visual Studio 中的 // 和 /// 有什么区别?

Stylecop 告诉我在评论时使用 /// 而不是 //。这两者的语义区别是什么?我什么时候应该使用哪一个?

0 投票
4 回答
16322 浏览

支持文档中包含哪些核心元素?

我创建了一个应用程序,需要在下个月“移交”给支持小组。

该应用程序相当小(开发 2 个月),由两个客户端应用程序和一个数据库组成,它是用 c# 为 windows 平台编写的。

我对支持文档中包含的内容有一个广泛的想法,但到目前为止,在我的职业生涯中,我不需要制作很多支持文档,我希望包含一个可靠的项目列表。

我想我的目标是让支持小组中的每个人的生活更轻松,并尽可能无压力。

所以我想我的问题是:

  1. 支持文件绝对应该包含什么

  2. 您在支持文档中添加了哪些其他内容以使它们更加有用。

  3. 在移交之前可以进行哪些其他活动以使我们的生活更轻松?


15 30 50 per page
1
2 3 4 5
1498226