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

28th IEEE International Conference on Software Analysis, Evolution and Reengineering (SANER)

作者： Steinbeck, Marcel Koschke, Rainer Univ Bremen Bremen Germany

ISBN: (纸本)9781728196305

Software quality comprises different and interrelated aspects. One of them is maintainability, which in turn is made up of measurable attributes. Previous studies have shown that documentation, by contributing to the comprehensibility of software, may have a positive effect on maintainability and, hence, software quality. This paper presents a study in which we analyzed javadoc comments from 163 different open-source projects. javadoc is the de facto standard for documenting source code files in Java projects, and although its syntax is less strict than in other (programming) languages, documentation written with javadoc may contain violations. Our study focuses on the detection of different types of javadoc violations as well as the source code elements affected by them. Also, by utilizing software repository mining techniques, we examined the history of the subject systems to gain further insights into the evolution of javadoc violations. According to our results, about half of the source code elements have no javadoc whatsoever. Among the different components of javadoc comments (if present), the description of exceptions, by far, has the highest average ratio of violations. With regard to the types of affected elements, constructors and methods show very high average ratios. Also, we found that, on average, violations live more than two years. Nowadays, most integrated development environments (IDEs) for Java are capable of detecting missing javadoc comments as well as comments with syntactic errors. However, our results indicate that the documentation of source code might be considered less important to developers or that these tools alone may not be sufficient for maintaining consistent documentation.

关键词： javadoc open-source software evolution static analysis

来源：评论

学校读者我要写书评

暂无评论

使用javadoc自动生成标准API文档

引用

天津职业院校联合学报 2013年第7期15卷 103-106页

作者：谢艳芳天津开发区职业技术学院天津滨海新区300457

本文主要讲述了使用javadoc自动生成标准API文档的方法,其中包括为java源程序添加特定注释信息、标记的方法以及运行javadoc命令的常用方法,最后介绍了为HTML文档添加图像信息的方法。

关键词： javadoc 注释 API 标记 HTML

来源：评论

学校读者我要写书评

暂无评论

Assessing the quality factors found in in-line documentation written in natural language: The javadocMiner

引用

DATA & KNOWLEDGE ENGINEERING 2013年 87卷 19-40页

作者： Khamis, Ninus Rilling, Juergen Witte, Rene Concordia Univ Dept Comp Sci & Software Engn Montreal PQ Canada

An important software engineering artifact used by developers and maintainers to assist in software comprehension and maintenance is source code documentation. It provides the insight needed by software engineers when performing a task, and therefore ensuring the quality of this documentation is extremely important. In-line documentation is at the forefront of explaining a programmer's original intentions for a given implementation. Since this documentation is written in natural language, ensuring its quality so far needed to be performed manually. In this paper, we present an effective and automated approach for assessing the quality of in-line documentation using a set of heuristics, targeting both the quality of language and consistency between the source code and its comments. Our evaluation is made up of two parts: We first apply the javadocMiner tool to the different modules of two open source applications (ArgoUML and Eclipse) in order to automatically assess their intrinsic comment quality. In the second part of our evaluation, we correlate the results returned by the analysis with bug defects reported for the individual modules in order to examine connections between natural language documentation and source code quality. (C) 2013 Elsevier B.V. All rights reserved.

关键词： Text mining Software engineering Source code comments Automated quality analysis javadoc Ontology

来源：评论

学校读者我要写书评

暂无评论

tools of the trade Code Documentation

引用

IEEE SOFTWARE 2010年第4期27卷 18-19页

作者： Spinellis, Diomidis Athens Univ Econ & Business Dept Management Sci & Technol Athens Greece

The basic principles of good code documentation include the avoidance of repetition, the coexistence of code and its documentation, the documentation of all artifacts, and a preference for clear code and automated processes to explanatory documentation. Existing tools can help us by extracting documentation from specially formatted comments and by formatting code listed in documents. We can also automate the generation of bespoke documentation with a custom-made tool. When you document code, strive for completeness, consistency, effortless accessibility, and an automated low-overhead generation process.

关键词： Documentation Java Manuals Software Programming Libraries Best practices software engineering comments documentation principles tools best practices javadoc POD

来源：评论

学校读者我要写书评

暂无评论

Pushing Relevant Artifact Annotations in Collaborative Software Development 08

Pushing Relevant Artifact Annotations in Collaborative Softw...

引用

ACM Conference on Computer Supported Cooperative Work

作者： Dekel, Uri Herbsleb, James D. Carnegie Mellon Univ SCS Pittsburgh PA 15213 USA

ISBN: (纸本)9781605580074

Recent techniques show the benefits of attaching community-generated knowledge to artifacts in an information space and presenting it to subsequent readers. We argue that such knowledge may also be relevant to the readers of artifacts which link to this target. Such situations are particularly frequent in software development, where a lack of awareness of critical directives associated with an invoked function can lead to costly errors. We describe how eMoose, a group memory-aid for this domain, addresses these problems by visually "pushing" annotated knowledge from invocation targets into the invoking code. Similar techniques could potentially be applied to other development phases and to other domains.

关键词： Context Annotations Tagging javadoc Pushing

来源：评论

学校读者我要写书评

暂无评论

Documenting APIs with Examples: Lessons Learned with the APIMiner Platform

Documenting APIs with Examples: Lessons Learned with the API...

引用

20th Working Conference on Reverse Engineering

作者： Montandon, Joao Eduardo Borges, Hudson Felix, Daniel Valente, Marco Tulio Univ Fed Minas Gerais Dept Comp Sci Belo Horizonte MG Brazil

ISBN: (纸本)9781479929313

Software development increasingly relies on Application Programming Interfaces (APIs) to increase productivity. However, learning how to use new APIs in many cases is a non-trivial task given their ever-increasing complexity. To help developers during the API learning process, we describe in this paper a platform-called APIMiner-that instruments the standard Java-based API documentation format with concrete examples of usage. The examples are extracted from a private source code repository-composed by real systems-and summarized using a static slicing algorithm. We also describe a particular instantiation of our platform for the Android API. To evaluate the proposed solution, we performed a field study, when professional Android developers used the platform by four months.

关键词： API documentation source code examples javadoc field study

来源：评论

学校读者我要写书评

暂无评论

Constructural Software Documentation 19

Constructural Software Documentation

引用

IEEE/ACM 41st International Conference on Software Engineering - Software Engineering in Practice (ICSE-SEIP)

作者： Nassif, Mathieu Robillard, Martin P. McGill Univ Sch Comp Sci Montreal PQ Canada

ISBN: (纸本)9781728117645

Software projects capture information in artifacts that include production code, test suites, and documentation. Because different artifacts serve different purposes, some artifacts can include redundant information, encoded in different formats. To mitigate this redundancy, we propose an approach to explicitly encode in unit tests information that will be automatically extracted and added to the documentation of the software. We implemented this approach in the form of an Eclipse plug-in that binds unit tests written with JUnit to the header comments of the tested methods.

关键词： Constructural documentation Unit testing Automatic documentation Documentation extraction javadoc

来源：评论

学校读者我要写书评

暂无评论

Evolution support by homogeneously documenting patterns, aspects and traces

Evolution support by homogeneously documenting patterns, asp...

引用

6th European Conference on Software Maintenance and Reengineering (CSMR 2002)

作者： Sametinger, J Riebisch, M Johannes Kepler Univ A-4040 Linz Austria

ISBN: (纸本)0769514383

The evolution of complex so are systems is promoted by software engineering principles and techniques like separation of concerns, encapsulation, stepwise refinement, and reusability of design solutions. Design patterns capture the expertise for reusable design solutions. Aspect-oriented programming is a methodology that enables the modularization of cross-cutting concerns. Traceability links designate dependencies between requirements, design, and source code. In order to support maintenance, documentation has to enable understandability by describing these issues. Descriptions have to facilitate tool support for automating documentation activities. In this paper, we use the notion of patterns, aspects and traces for a homogeneous documentation approach. We integrate various types of documentation, keep track of traces from requirements to the source code, keep design information in the source code, and generate additional design views on software systems. We have implemented these ideas as an extension to javadoc, the documentation approach used by Java. This extension can be used to automatically generate views on the design and on aspects as well as on traceability links as part of the standard javadoc system documentation.

关键词： evolution maintenance documentation design pattern traceability object-oriented design javadoc

来源：评论

学校读者我要写书评

暂无评论

Extraction of archetype from near duplicates in software documentation

Extraction of archetype from near duplicates in software doc...

引用

6th Conference on Actual Problems of Systems and Software Engineering (APSSE)

作者： Koznov, Dmitry Luciv, Dmitry Chernishev, George Grigoryev, Dmitry St Petersburg State Univ Software Engn Dept St Petersburg Russia St Petersburg State Univ Analyt Informat Syst Dept St Petersburg Russia St Petersburg State Univ Dept Comp Sci St Petersburg Russia

ISBN: (纸本)9781728160610

Software documentation contains a large amount of duplicate text, which is often comprised of near duplicates - repetitions of the same text with slight differences. They emerge due to numerous copy-pastes that have been slightly modified. Uncontrolled near duplicates complicate documentation support to a significant degree. There are some research papers on detection and management of duplicates in software documentation, but only the Duplicate Finder approach addresses the problem of near duplicates. Nevertheless, Duplicate Finder's search algorithms do not provide extraction of archetype (common text) for detected groups of near duplicates (a set of near duplicates belong to one group if they have a lot of commonalities). Archetype of group can be used in visualization of the common text and differences of duplicates for manual analysis, as well as for reuse of documentation. In this paper, we present an algorithm for archetype extraction and results of experiments on documentation of several well-known open source Java projects JUnit, Mockito, SLF4J.

关键词： Software Documentation javadoc Duplicates Near Duplicates

来源：评论

学校读者我要写书评

暂无评论

Designing a memory aid to support software developers

Designing a memory aid to support software developers

引用

23rd ACM SIGPLAN Conference on Object Oriented Programming Systems Languages and Applications,OOPSLA 2008

作者： Dekel, Uri ISR School of Computer Science Carnegie Mellon University United States

Developers rely on knowledge of project artifacts to avoid usage errors and on knowledge of their activities to maintain orientation and trace decisions. Unfortunately, human memory is unreliable, and existing documentation practices are costly and limited in their ability to draw attention to preserved knowledge. We propose a unified memory aid aimed at addressing these problems using episodic and contextual presentations of lightweight subjective knowledge elements supplied by the developers and objective events elicited from IDE monitors. In particular, directives on call targets are pushed into the attention of client code authors.

关键词： Awareness Documentation javadoc

来源：评论

学校读者我要写书评

暂无评论

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

时间限定

文献类型

馆藏选择

核心期刊

语言

文献类型

帮助

文字说明：

检索规则说明：

检索范例：

分类表

所选分类

限定检索结果

文献类型

馆藏范围

日期分布

学科分类号

主题

机构

作者

语言

请选择保存的检索档案：

请选择收藏分类：

通借通还

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

时间限定

文献类型

馆藏选择

核心期刊

语言

文献类型

帮助

文字说明：

检索规则说明：

检索范例：

分类表

所选分类

限定检索结果

文献类型

馆藏范围

日期分布

学科分类号

主题

机构

作者

语言

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

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

通借通还

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

请选择保存的检索档案：

请选择收藏分类：