问题标签 [self-documenting]
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.
python - 记录类属性
以下示例取自“Dive into python”一书。
此示例显示记录 MP3FileInfo，但如何向 MP3FileInfo 添加帮助。标记数据映射
boolean - 程序员应该使用布尔变量来“记录”他们的代码吗？
我正在阅读 McConell 的Code Complete，他讨论了使用布尔变量来记录您的代码。例如，而不是：
他建议：
这让我觉得这是合乎逻辑的、良好的实践和非常自我记录的。但是，我对是否开始经常使用这种技术犹豫不决，因为我几乎从未遇到过。也许仅仅因为稀有而令人困惑。但是，我的经验还不是很丰富，所以我很想听听程序员对这种技术的看法，我很想知道是否有人经常使用这种技术，或者在阅读代码时经常看到它。这是一个值得采用的约定/风格/技术吗？其他程序员会理解和欣赏它，还是认为它很奇怪？
doxygen - 记录一个库 - 一切或只是公共头文件中的功能？
如果您正在开发和记录一个库..您是记录每个源文件中的每个函数/数据结构，还是只记录公共头文件中出现的公共文件？
我倾向于第二个选项，这样可以吗？
sql - 在 SQL Server 中，自我记录是什么意思？
我在阅读中遇到了这个术语。这是上下文：
“最好的做法是让你的 T-SQL 代码自记录。一般来说，如果视图的列名在 SELECT 语句中指定，而不是在视图中单独列出，则视图会更加自记录。”
我只是好奇这意味着什么。非常感谢任何回应。
r - 在 RData（R 工作区）文件中嵌入 README 消息的最便携方式
我正在开发一个工作流程，其中验证用户提交的数据并运行一些初步统计测试，然后将生成的工作空间发送给统计学家进行进一步分析。
在某些情况下，RData 文件将被发送给在此之前不熟悉该项目的统计学家。我希望他们能够打开 RData 文件并显示一条总结项目的消息，告诉他们他们打开的工作空间中包含什么，以及他们可以在其中查找更多信息的 URL。
问题是，我试图尽可能少地依赖统计学家运行命令或加载包。我能想到的最好的就是这个（在创建 RData 文件期间）：
然后 your_output.RData 是统计学家将从他们的 R 会话中打开的文件。
这是次优的，因为它假定统计学家将在控制台输入“ls”，而不是让某种接口（例如 ESS）为他们做这件事（并且可能会出错）。此外，即使我是出于用户友好的原因，弄乱它们的基本功能也感觉很粗略。
我想到的另一件事是让 README 成为一个自定义类，并将 S3 打印方法连同它一起保存在 RData 文件中，但并不是每个人都会立即将完整的对象打印到他们的控制台。我可能会尝试一下class()，head()谁知道其他人首先会做什么。
该.First()命令的文档说（强调我的）......
函数“.First”（和“.Last”）可以在适当的“.Rprofile”或“Rprofile.site”文件中定义或保存在“.RData”中。
...但是如果我从已经运行的会话中打开 RData 文件，.First()则不会执行。
当有人以最少的用户输入（最好是没有输入）打开 RData 文件时，是否有人知道显示一次性消息的方法？
php - GraphQL 不是自我记录的
我已经为我正在使用 webonyx/graphql-php 的项目创建了一个 GraphQL API。我正在使用 Altair Chrome 插件对其进行测试。API 本身工作正常，我可以毫无问题地获取数据，但是 Altair 没有显示任何类型的 API 文档。当我点击重新加载按钮时，我可以在网络选项卡中看到 Altair 请求 IntrospectionQuery 并且我的服务器确实回复了一个大的 JSON 文件，但是，Altair 中没有出现任何文档。因为我在使用其他 GraphQL API 时确实有文档，所以我很确定问题出在我这边，但我不知道我做错了什么。
找到随附的 JSON（由于大小限制而减少）：