#4291·backbone

帮助读者理解代码

作者: jgonggrijp创建于 2024年7月25日更新于 2026年8月17日
标签enhancementdocumentationquality

@jdittrich in https://GitHub.com/jashkenas/backbone/issues/4290#issuescomment-2250480128 : (中文(简体) ).

我想知道,代码的可读性/学习/预期性能否成为更新的重点? 这不限于代码本身,而且还包括文件。 这不会是一个强烈的转变(尽管我发现有时很难理解事件处理代码),并可能带来一些潜在的妥协,因为容易理解可能优于性能,以及建筑文件(线条评论和当前文件之间的某种内容)

我在https://GitHub.com/jashkenas/backbone/issues/4290#issuescomment-2250776180中:

请详细介绍你希望如何看到这一中间文件?

@jdittrich in https://GitHub.com/jashkenas/backbone/issues/4290#issuescomment-2250875377 : (中文(简体) ).

中间文档 翻译: ..对我来说 通常涉及 翻译:

  • JSDoc可能有助于合同/互动?

翻译: 翻译: 基本上,一些有助于理解代码的不同部分如何一起工作以及如何读取代码的东西.

我怀疑如果有图表可以直观地显示代码不同部分之间的关系,那会很有帮助。 这些内容可以列入Docco注解来源,因为它支持评论中的Markdown。

欢迎各方提出意见并提出要求.

内容来源: jashkenas/backbone