知识卡片
文档生成器提取源码注释
文档生成工具可从源码中的特定注释格式提取接口说明,生成带链接的阅读页面。原例使用C#三斜线注释和ndoc,RDoc、javadoc也被用来说明相似能力。它把说明靠近代码,却不自动校验语义准确或防止过时;输出美观与契约正确是两件事。
这张卡片看不懂?
这张卡片的反馈已满 10 条,暂时无法继续提交。
已有反馈 · 0 / 10 条
还没有人提交反馈。
在整书笔记中的位置
原书出处 · 1 处
- · 查看原书依据
抽取注释,并生成样式漂亮且带有超链接的HTML输出。 下面是一段C#文档化代码的摘录。通常的注释用//开头,要生成文档的注释用///开头(当然这仍然是合法的注释)。 using System; namespace Bank { /// <summary> /// A B
参考来源
- 位置:《高效程序员的45个习惯敏捷开发修炼之道 (图灵程序设计丛书 11)》26 用代码沟通(spine2;来源项目book-sources,`extracted/高效程序员的45个习惯敏捷开发修炼之道 (图灵程序设计丛书 11)/_epub-src/OEBPS/text00000.html`;来源键`u46-ch06-013`)。
- 结论依据:本单元完整正文、文本代码及相关图已实读;历史代码作为论证例,不冒称编译通过、性能测量或生产安全保证,源码排字错误按上下文明确处理。
- 原始内容:抽取注释,并生成样式漂亮且带有超链接的HTML输出。 下面是一段C#文档化代码的摘录。通常的注释用//开头,要生成文档的注释用///开头(当然这仍然是合法的注释)。 using System; namespace Bank { /// <summary> /// A B