Auto-documentation for stack overflow
In the field of software engineering, people often visit forums to exchange information, to seek or give advice. The provision of such rich and meaningful content allows software developers to understand the use of Application Programming Interface (API) but many of these developers may find the con...
| Main Author: | |
|---|---|
| Other Authors: | |
| Format: | Final Year Project (FYP) |
| Language: | English |
| Published: |
2017
|
| Subjects: | |
| Online Access: | http://hdl.handle.net/10356/70276 |
| _version_ | 1811697012103446528 |
|---|---|
| author | Tan, Ri Sheng |
| author2 | Lin Shang-Wei |
| author_facet | Lin Shang-Wei Tan, Ri Sheng |
| author_sort | Tan, Ri Sheng |
| collection | NTU |
| description | In the field of software engineering, people often visit forums to exchange information, to seek or give advice. The provision of such rich and meaningful content allows software developers to understand the use of Application Programming Interface (API) but many of these developers may find the content insufficient and require additional explanation from the API documentation.
Fortunately, for some of the APIs mentioned in forum posts, it is manually linked by forum users, readers can click on the links to visit its official API documentations for explanation and save themselves from performing a manual search on search engines for the API documentations.
However, for those APIs that are mentioned but are not manually linked by forum users, readers will need to perform a manual search on search engines for the API documentation, wasting time and resources which can be avoided by automatically linking the sentence that contains an API mention to its API documentation. The prerequisite to linking a sentence that contains an API mention to its official API documentation is the extraction of the fully qualified API name of the API mentioned, as establishing such link is only possible with the fully qualified API name known.
In this report, we considered two possible API extraction methods – IF-THEN rules and Naïve Bayes – to perform extraction of a fully qualified API name from a sentence. After weighing the pros and cons, we designed and developed a Naïve Bayes API extraction method. The Naïve Bayes API extraction method was evaluated against two baseline methods based on the fully qualified API names collected from four popular Python libraries, of which Naïve Bayes API extraction method outperformed the two baseline methods. |
| first_indexed | 2024-10-01T07:48:29Z |
| format | Final Year Project (FYP) |
| id | ntu-10356/70276 |
| institution | Nanyang Technological University |
| language | English |
| last_indexed | 2024-10-01T07:48:29Z |
| publishDate | 2017 |
| record_format | dspace |
| spelling | ntu-10356/702762023-03-03T20:33:56Z Auto-documentation for stack overflow Tan, Ri Sheng Lin Shang-Wei School of Computer Science and Engineering DRNTU::Engineering::Computer science and engineering::Information systems In the field of software engineering, people often visit forums to exchange information, to seek or give advice. The provision of such rich and meaningful content allows software developers to understand the use of Application Programming Interface (API) but many of these developers may find the content insufficient and require additional explanation from the API documentation. Fortunately, for some of the APIs mentioned in forum posts, it is manually linked by forum users, readers can click on the links to visit its official API documentations for explanation and save themselves from performing a manual search on search engines for the API documentations. However, for those APIs that are mentioned but are not manually linked by forum users, readers will need to perform a manual search on search engines for the API documentation, wasting time and resources which can be avoided by automatically linking the sentence that contains an API mention to its API documentation. The prerequisite to linking a sentence that contains an API mention to its official API documentation is the extraction of the fully qualified API name of the API mentioned, as establishing such link is only possible with the fully qualified API name known. In this report, we considered two possible API extraction methods – IF-THEN rules and Naïve Bayes – to perform extraction of a fully qualified API name from a sentence. After weighing the pros and cons, we designed and developed a Naïve Bayes API extraction method. The Naïve Bayes API extraction method was evaluated against two baseline methods based on the fully qualified API names collected from four popular Python libraries, of which Naïve Bayes API extraction method outperformed the two baseline methods. Bachelor of Engineering (Computer Science) 2017-04-18T07:28:38Z 2017-04-18T07:28:38Z 2017 Final Year Project (FYP) http://hdl.handle.net/10356/70276 en Nanyang Technological University 62 p. application/pdf |
| spellingShingle | DRNTU::Engineering::Computer science and engineering::Information systems Tan, Ri Sheng Auto-documentation for stack overflow |
| title | Auto-documentation for stack overflow |
| title_full | Auto-documentation for stack overflow |
| title_fullStr | Auto-documentation for stack overflow |
| title_full_unstemmed | Auto-documentation for stack overflow |
| title_short | Auto-documentation for stack overflow |
| title_sort | auto documentation for stack overflow |
| topic | DRNTU::Engineering::Computer science and engineering::Information systems |
| url | http://hdl.handle.net/10356/70276 |
| work_keys_str_mv | AT tanrisheng autodocumentationforstackoverflow |