DOI: 10.5281/zenodo.5296443
title: Replication package for the paper "Do Comments follow Commenting Conventions? A case study in Java and Python"

description: <pre><code class="language-markdown"># RP-comment-convention-adherence-Java-Python Replication Package for the paper "Do Comments follow Commenting Conventions? A case study in Java and Python". It uses the dataset provided by Rani et.al.'s work [How to identify class comment types? A multi-language approach for class comment classification](https://github.com/poojaruhal/RP-class-comment-classification). ## Structure ``` RQ1/ RQ1_Java_Rules.xlsx RQ1_Python_Rules.xlsx RQ2/ RQ1_Java_Comments_Validated.xlsx RQ1_Python_Comments_Validated.xlsx Raw-projects/ Java_projects/ eclipse.zip guava.zip guice.zip hadoop.zip spark.zip vaadin.zip Python_projects/ django.zip ipython.zip Mailpile.zip pandas.zip pipenv.zip pytorch.zip requests.zip Style-guides ``` ## Contents of the Replication Package --- - **RQ1/** - contains the data used to answer RQ1 - `RQ1_Java_Rules.xlsx` - contains comment-related rules extracted from various Java style guidelines. Various tabs in the sheet represent the rules extracted from standard or project-specific guidelines. Oracle and Google are the standard guidelines, and the remaining are specific to the projects. - `RQ1_Python_Rules.xlsx` - contains comment-related rules extracted from various Python style guidelines. Various tabs in the sheet represent the rules extracted from standard or project-specific guidelines. PEP, Numpy, and Google are the standard guidelines and the remaining are specific to the projects. - **RQ2/** - contains the data used to answer RQ2 - `RQ2_Java_Comments_Validated.xlsx` - contains Java comment dataset used from the previous work and validated against the rules from their corresponding guidelines. Various tabs in the sheet represent various Java projects used in the work. The rows in each tab show the sample class comments used to validate against the rules. The rules are shown in the columns. - `RQ2_Python_Comments_Validated.xlsx` - contains Python comment dataset used from the previous work and validated against the rules from their corresponding guidelines. Various tabs in the sheet represent various Java projects used in the work. The rows in each tab show the sample class comments used to validate against the rules. The rules are shown in the columns. - **Raw-projects/** contains the raw projects of each language that are used to analyze class comments. - **Java_projects/** - `eclipse.zip` - Eclipse project downloaded from the GitHub. More detail about the project is on https://github.com/eclipse - `guava.zip` - Guava project downloaded from the GitHub. More detail about the project is on https://github.com/google/guava - `guice.zip` - Guice project downloaded from the GitHub. More detail about the project is on https://github.com/google/guice - `hadoop.zip` - Apache Hadoop project downloaded from the GitHub. More detail about the project is on https://github.com/apache/hadoop - `spark.zip` - Apache Hadoop project downloaded from the GitHub. More detail about the project is on https://github.com/apache/spark - `vaadin.zip` - Vaadin project downloaded from the GitHub. More detail about the project is on https://github.com/vaadin/framework - **Python_projects/** - `django.zip` - Django project downloaded from the GitHub. More detail about the project is on https://github.com/django. - `ipython.zip` - IPython project downloaded from the GitHub. More detail about the project is on https://github.com/ipython/ipython - `Mailpile.zip` - Mailpile project downloaded from the GitHub. More detail about the project is on https://github.com/mailpile/Mailpile - `pandas.zip` - pandas project downloaded from the GitHub. More detail about the project is on https://github.com/pandas-dev/pandas - `pipenv.zip` - Pipenv project downloaded from the GitHub. More detail about the project is on https://github.com/pypa/pipenv - `pytorch.zip` - PyTorch project downloaded from the GitHub. More detail about the project is on https://github.com/pytorch/pytorch - `requests.zip` - Requests project downloaded from the GitHub. More detail about the project is on https://github.com/psf/requests/ - **Style-guides/**- contains the style guidelines used for the selected projects. ---</code></pre>