首页    期刊浏览 2024年11月28日 星期四
登录注册

文章基本信息

  • 标题:Sustainable, Extensible Documentation Generation Using inlinedocs
  • 本地全文:下载
  • 作者:Toby Dylan Hocking ; Thomas Wutzler ; Keith Ponting
  • 期刊名称:Journal of Statistical Software
  • 印刷版ISSN:1548-7660
  • 电子版ISSN:1548-7660
  • 出版年度:2013
  • 卷号:54
  • 期号:1
  • 页码:1-20
  • 语种:English
  • 出版社:University of California, Los Angeles
  • 摘要:This article presents inlinedocs, an R package for generating documentation from comments. The concept of structured, interwoven code and documentation has existed for many years, but existing systems that implement this for the R programming language do not tightly integrate with R code, leading to several drawbacks. This article attempts to address these issues and presents 2 contributions for documentation generation for the R community. First, we propose a new syntax for inline documentation of R code within comments adjacent to the relevant code, which allows for highly readable and maintainable code and documentation. Second, we propose an extensible system for parsing these comments, which allows the syntax to be easily augmented.
国家哲学社会科学文献中心版权所有