检索结果-内蒙古大学图书馆

SOFTWARE-PRACTICE & EXPERIENCE 1977年第6期7卷 779-792页

作者： SCOWEN, RS National Physical Laboratory Teddington Middlesex England

The documentation of computer programs can be considerably eased and standardized using the programs described in this paper. They are basically machine- and language-independent, possess a simple structure, use one serial input and one output stream, and require no backing store. The code size for each program is a few thousand bytes and the time for running them is dominated by that needed for input and output. The programs are: 1 INDEX (gives an index of all identifiers used in a program). 2 POLISH (paginates a program listing so that the global structure is evident). 3 WATER (helps find misprints in computer-readable reports). 4 UNDOC (creates a live program from its documented form). Also included are examples of the output from these programs.

关键词： Concordance Cross-reference listing Portable software program documentation program listings Typographical errors

来源：评论

学校读者我要写书评

暂无评论

Executable program documentation Based on Debugging Break Points 20

Executable Program Documentation Based on Debugging Break Po...

引用

20th Asia-Pacific Software Engineering Conference (APSEC)

作者： Cheng, Yung-Pin Chen, Jhih-Hao Yu, Yu-Ying Natl Cent Univ Dept Comp Sci & Info Engn Zhongli City 32001 Taiwan Natl Taiwan Normal Univ Dept Comp Sci & Info Engn Taipei Taiwan

ISBN: (纸本)9781479921430

Understanding an unfamiliar program is always a daunting task for any programmer, either experienced or inexperienced. Many studies have shown that even an experienced programmer who is already familiar with the code may still need to rediscover the code frequently during maintenance activities. Compared to that tracing the source code of an unfamiliar program is a totally different process of comprehension. Difficulties in such a process can be compounded if the code has poor or little internal program documentation. In practice, internal program documentation is often neglected or receives much less attention while most documentation techniques are designed to help programmers deal with familiar code, not unfamiliar code. In this paper, a novel internal program documentation method is proposed. In the approach, the multimedia documents, such as slides and voice recording, can be created along with a sequence of debugging break points, where the sequence of break points and its associated multimedia documents form a trace case. We show that trace cases can be very useful in documenting major control flows of a program using examples so that the time needed to construct a program model for understanding can be shortened. To demonstrate the idea, a prototype tool called polyTraceAid has been implemented as a plug-in in Visual Studio.

关键词： program documentation program comprehension executable documents debugger multimedia documents

来源：评论

学校读者我要写书评

暂无评论

An approach to high-level behavioral program documentation allowing lightweight verification

An approach to high-level behavioral program documentation a...

引用

14th IEEE International Conference on program Comprehension (ICPC 2006)

作者： De Roover, Coen Michiels, Isabel Gybels, Kim Gybels, Kris D'Hondt, Theo Vrije Univ Brussel Programming Technol Lab Pleinlaan 2 B-1050 Brussels Belgium

ISBN: (纸本)0769526012

Typically, multiple developers are involved in the various stages of the software development and maintenance process. To ensure an optimal transfer of knowledge between these different peers, a reliable human-readable model of the dynamics of a software artefact is needed Once these models become machine-verifiable, they can be used throughout an application's lifetime to check whether the documented behavioral properties continue to hold as the application evolves. Unfortunately, most existing modeling media are inadequate to express human-readable behavioral models which are at the same time machine-verifiable. We therefore propose a declarative platform wherein behavioral program models can be expressed in terms of user-defined high-level concepts and be automatically verified against an application's actual behavior We demonstrate our approach by using it to both document and verify an interpreter for a garbage-collected programming language.

关键词： program documentation

来源：评论

学校读者我要写书评

暂无评论

引用

IEEE International Professional Communication Conference (IPCC)

作者： Tilley, Scott Parveen, Tauhida Florida Inst Technol Dept Comp Sci Melbourne FL 32901 USA

ISBN: (纸本)9781457721243

program documentation is a vital source of information for software engineers charged with making changes to complex applications. Test documentation can be used to help future stakeholders understand the rationale behind the testing effort. This panel will discuss some of the similar features and salient differences between program documentation and test documentation. Although both types of documentation are usually written by and for different groups of people (for reasonable-sized projects), there is enough overlap that each could be improved by studying the communication strategies of the other.

关键词： Communication program documentation test documentation

来源：评论

学校读者我要写书评

暂无评论

Intensive program documentation

Intensive Program Documentation

引用

4th International Conference on Computer Science and Informatics, JCIS 1998

作者： Shih, Timothy K. Deng, Lawrence Y.G. Lin, Yule C. Multimedia Information Network Lab Department of Computer Science Tamkang University Tamsui Taipei Hsien 251 Taiwan

program documents are very important in understanding a program. But current program comment mechanism is awkward and unfriendly to read and writ, it cannot annotate a program clearly and completely. This paper proposes a different approach of program comments, programmers are no to longer to write comments randomly and arbitrarily. Our system will ask programmers to annotate a program according to the specification embedded in the grammar, programmers can use not only text, but video and sound to express the meaning of a program easily and completely. The quantity of comments will be put into a database, which can be queried by the project managers, customers, and software quality assurance specialists etc. to acquire a comprehensive software metrics of program comments. Besides the program and comments are represented as the HTML format, which can be browsed by most browsers via Internet.

关键词： program documentation

来源：评论

学校读者我要写书评

暂无评论

VerifyThis 2023: An International program Verification Competition 3rd

VerifyThis 2023: An International Program Verification Compe...

引用

3rd International TOOLympics Challenge

作者： Denis, Xavier Siegel, Stephen F. Univ Paris Saclay INRIA ENS Paris Saclay Lab Methodes Formelles F-91190 Gif Sur Yvette France Univ Delaware Newark DE 19716 USA

ISBN: (纸本)9783031676949;9783031676956

The 11th VerifyThis program verification competition took place on April 22, 2023, at ETAPS 2023 in Paris, France. Contestants were tasked with solving three verification challenges in real time, using any tools of their choice. The subjects of the challenges were (1) in-place reversal of a linked list, (2) ordered binary decision diagrams, and (3) a concurrent FIFO queue. Fifteen teams, each with 1 or 2 members, participated;all were required to be present on site. In this report, we summarize the three challenges and some of the notable solutions.

关键词： program documentation

来源：评论

学校读者我要写书评

暂无评论

CoDocBench: A Dataset for Code-documentation Alignment in Software Maintenance

arXiv

引用

arXiv 2025年

作者： Pai, Kunal Devanbu, Premkumar Ahmed, Toufique University of California Davis United States

One of the central tasks in software maintenance is being able to understand and develop code changes. Thus, given a natural language description of the desired new operation of a function, an agent (human or AI) might be asked to generate the set of edits to that function to implement the desired new operation;likewise, given a set of edits to a function, an agent might be asked to generate a changed description, of that function’s new workings. Thus, there is an incentive to train a neural model for change-related tasks. Motivated by this, we offer a new, "natural", large dataset of coupled changes to code and documentation mined from actual high-quality GitHub projects, where each sample represents a single commit where the code and the associated docstring were changed together. We present the methodology for gathering the dataset, and some sample, challenging (but realistic) tasks where our dataset provides opportunities for both learning and evaluation. We find that current models (specifically Llama-3.1 405B, Mixtral 8×22B) do find these maintenance-related tasks challenging. © 2025, CC BY.

关键词： program documentation

来源：评论

学校读者我要写书评

暂无评论

Learning from Mistakes: Understanding Ad-hoc Logs through Analyzing Accidental Commits

arXiv

引用

arXiv 2025年

作者： Chou, Yi-Hung Min, Yiyang Wang, April Yi Jones, James A. University of California Irvine Irvine United States ETH Zurich Zurich Switzerland

Developers often insert temporary "print" or "log" instructions into their code to help them better understand runtime behavior, usually when the code is not behaving as they expected. Despite the fact that such monitoring instructions, or "ad-hoc logs," are so commonly used by developers, there is almost no existing literature that studies developers' practices in how they use them. This paucity of knowledge of the use of these ephemeral logs may be largely due to the fact that they typically only exist in the developers' local environments and are removed before they commit their code to their revision control system. In this work, we overcome this challenge by observing that developers occasionally mistakenly forget to remove such instructions before committing, and then they remove them shortly later. Additionally, we further study such developer logging practices by watching and analyzing live-streamed coding videos. Through these empirical approaches, we study where, how, and why developers use ad-hoc logs to better understand their code and its execution. We collect 27 GB of accidental commits that removed 548,880 ad-hoc logs in JavaScript from GitHub Archive repositories to provide the first large-scale dataset and empirical studies on ad-hoc logging practices. Our results reveal several illuminating findings, including a particular propensity for developers to use ad-hoc logs in asynchronous and callback functions. Our findings provide both empirical evidence and a valuable dataset for researchers and tool developers seeking to enhance ad-hoc logging practices, and potentially deepen our understanding of developers' practices towards understanding of software's runtime behaviors. © 2025, CC BY-NC-SA.

关键词： program documentation

来源：评论

学校读者我要写书评

暂无评论

An Empirical Study of Dotfiles Repositories Containing User-Specific Configuration Files

arXiv

引用

arXiv 2025年

作者： Zhu, Wenhan Godfrey, Michael W. David R. Cheriton School of Computer Science Canada

Storing user-specific configuration files in a "dotfiles" repository is a common practice among software developers, with hundreds of thousands choosing to publicly host their repositories on GitHub. This practice not only provides developers with a simple backup mechanism for their essential configuration files, but also facilitates sharing ideas and learning from others on how best to configure applications that are key to their daily workflows. However, our current understanding of these repository sharing practices is limited and mostly anecdotal. To address this gap, we conducted a study to delve deeper into this phenomenon. Beginning with collecting and analyzing publicly-hosted dotfiles repositories on GitHub, we discovered that maintaining dotfiles is widespread among developers. Notably, we found that 25.8% of the top 500 most-starred GitHub users maintain some form of publicly accessible dotfiles repository. Among these, configurations for text editors like Vim and shells such as bash and zsh are the most commonly tracked. Our analysis reveals that updating dotfiles is primarily driven by the need to adjust configurations (63.3%) and project meta-management (25.4%). Surprisingly, we found no significant difference in the types of dotfiles observed across code churn history patterns, suggesting that the frequency of dotfile modifications depends more on the developer than the properties of the specific dotfile and its associated application. Finally, we discuss the challenges associated with managing dotfiles, including the necessity for a reliable and effective deployment mechanism, and how the insights gleaned from dotfiles can inform tool designers by offering real-world usage information. © 2025, CC BY.

关键词： program documentation

来源：评论

学校读者我要写书评

暂无评论

Software design for analysis of multichannel intracardial and body surface electrocardiograms

引用

COMPUTER METHODS AND programS IN BIOMEDICINE 2002年第3期69卷 225-236页

作者： Potse, M Linnenbank, AC Grimbergen, CA Univ Amsterdam Acad Med Ctr Dept Med Phys NL-1100 DE Amsterdam Netherlands Univ Amsterdam Acad Med Ctr Expt Cardiol Dept NL-1105 AZ Amsterdam Netherlands Delft Univ Technol Fac Design Construct & Prod Control Dept Delft Netherlands

Analysis of multichannel ECG recordings (body surface maps (BSMs) and intracardial maps) requires special software. We created a software package and a user interface on top of a commercial data analysis package (MATLAB) by a combination of high-level and low-level programming. Our software was created to satisfy the needs of a diverse group of researchers. It can handle a large variety of recording configurations. It allows for interactive usage through a fast and robust user interface, and batch processing for the analysis of large amounts of data. The package is user-extensible, includes routines for both common and experimental data processing tasks, and works on several computer platforms. The source code is made intelligible using software for structured documentation and is available to the users. The package is currently used by more than ten research groups analysing ECG data worldwide. (C) 2002 Elsevier Science Ireland Ltd. All rights reserved.

关键词： electrocardiography body surface mapping cardiac mapping program documentation literate programming

来源：评论

学校读者我要写书评

暂无评论

建议与咨询留下您的常用邮箱和电话号码，以便我们向您反馈解决方案和替代方法

时间限定

文献类型

馆藏选择

核心期刊

语言

文献类型

帮助

文字说明：

检索规则说明：

检索范例：

分类表

所选分类

限定检索结果

文献类型

馆藏范围

日期分布

学科分类号

主题

机构

作者

语言

请选择保存的检索档案：

请选择收藏分类：

通借通还

建议与咨询 留下您的常用邮箱和电话号码，以便我们向您反馈解决方案和替代方法

时间限定

文献类型

馆藏选择

核心期刊

语言

文献类型

帮助

文字说明：

检索规则说明：

检索范例：

分类表

所选分类

限定检索结果

文献类型

馆藏范围

日期分布

学科分类号

主题

机构

作者

语言

请选择保存的检索档案： 新增检索档案 确定 取消

请选择收藏分类： 新增自定义分类 确定 取消

通借通还

建议与咨询留下您的常用邮箱和电话号码，以便我们向您反馈解决方案和替代方法

请选择保存的检索档案：

请选择收藏分类：