问题标签 [documentation]

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

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

如何配置 DoxyGen 以记录 ActionScript 文件？

我已经在 doxygen 的搜索模式中包含了 *.as 和 *.asi 文件，但是类、函数和变量并没有显示在那里。

有没有人尝试过使用 C# 3.5的 ActiveRecord介绍示例？我不知何故感觉样本完全错误或过时了。XML 配置完全错误：

应该 ：

（如果我理解 nhibernate 配置语法正确..）

我想知道我做错了什么。在用户模型上调用 Count() 时出现“无法为用户执行 ExecuteQuery”异常。

不知道这可能是什么。教程源代码与页面上的源代码有很大不同（最明显的是 XML 配置），它是一个 VS2003 示例，在大多数情况下具有不同的语法（没有泛型等）。

有什么建议么？ActiveRecord 看起来很棒..

我从来自 java 的 Python 开始。

我想知道是否存在类似于 JavaDoc API 的东西，我可以在其中找到类、它的方法以及如何使用它的示例。

我发现从 Python（命令行）中使用help(thing)非常有帮助

我也发现了这个：

http://docs.python.org/2/

https://docs.python.org/2/py-modindex.html

但是，当您已经拥有要查找的类名时，它似乎会有所帮助。在 JavaDoc API 中，我有所有的类，所以如果我需要一些东西，我会向下滚动到一个“听起来像”我需要的类。或者有时我只是浏览所有类以查看它们的作用，当我需要一个功能时，我的大脑会想起我 我们在 javadoc 中看到过类似的东西记得！？

但我似乎没有在 Python 中找到类似的东西（尚未），这就是我发布这个 questin 的原因。

顺便说一句，我知道我最终会读到这个：

https://docs.python.org/2/library/

但是，好吧，我认为不是今天。

为即将到来的 C++ 项目提出了以下建议。

• C++ 编码标准，Sutter 和 Alexandrescu 着
• JSF Air Vehicle C++ 编码标准
• C++ 风格的元素
• 有效的 C++ 第 3 版，作者 Scott Meyers

还有其他选择吗？还是上面的列表应该在 C++ 项目中使用？

一些相关链接

• 你认为软件公司应该强加开发人员编码风格吗？
• https://stackoverflow.com/questions/66268/what-is-the-best-cc-coding-style-closed

假设我正在编写一些 ruby​​ 代码，并且我想使用标准 Date 类型来获取当前日期。除了使用搜索引擎，有没有更快的方法来找到这个类的文档？我知道我可以通过键入来获取 Date 的方法Date.methods，但据我所知，这并没有提供有关参数类型或返回值的详细信息。

欢迎编辑特定的答案。我选择的编辑器是 Emacs。

编写用户手册的人不一定是程序员，他们需要一个可视化编辑器。一个主要问题是创作工具的内部格式；它应该是可读的文本/html，因此很容易比较签入版本控制的各个页面的版本。

前段时间我开始使用Sandcastle为我们的一个项目生成一个文档网站。它运行良好，但我们一直只为项目中的类、方法、属性（...）编写文档，并且为整个项目和项目部分/模块/命名空间提供完全独立的文档。如果我可以将该文档合并在一起并将相应的文档添加到生成的帮助文件中，那就太好了，但我不知道该怎么做。

只是在命名空间声明中添加注释似乎不起作用（C#）：

有谁知道如何做到这一点？我知道这是有可能的，如果能拥有... :)

有什么好的论据可以说服其他人评论他们的代码？

我注意到许多程序员更喜欢在没有注释的情况下编写代码的感知速度，而不是为自己和他人留下一些文档。当我试图说服他们时，我会听到半生不熟的东西，比如“方法/类名应该说明它的作用”等。你会对他们说些什么来改变他们的想法？

如果您反对评论，请留下评论。对于试图说服人们评论代码的人来说，这应该是一种资源，而不是其他方式。:-)

其他相关问题是：评论代码，您是否评论您的代码以及您希望您的评论如何。

假设您正在编写或维护一段代码，该代码使用了一些您不是 100% 熟悉的 API。

你如何决定是否阅读某个调用目标的文档，以及花费多少时间阅读它？你怎么决定不读它？

（假设您可以通过打开 HTML 文档、检查源代码或使用 IDE 中的悬停机制来阅读它）。