Comentador

Comentador is a project that aims to translate source code written in Go or Prolog into natural language comments using NLP techniques. It consists of:

1. A Visual Studio Code Extension, for user interaction (this repo).
2. A trained ML model based on transformers, which provides translations services.
3. A dataset created from scratch.

🚀 Quick Start

As mentioned, this repo hosts the extension for VSCode and it is provided as support for an API in DockerHub, which contains the trained model. So to make it work, you must first deploy the Docker application:

docker run -dp 8000:1400 borgesvive/goprolog-backend:v1

You may run a specific model (PROLOG or GO) through an environment variable.

docker run -e MODEL="GO" -dp 8000:1400 borgesvive/goprolog-backend:v1

Once the backend is running, then you must download and install the VSCode extension.

1. In VSCode, select a function in Prolog or Go, as appropriate.
2. Invoke the command palette with Ctrl+Shift+P and search for "Comentar código".
3. Next, select the language.

You can adjust the server URL (which defaults to localhost) within the configuration tab of the extension in VSCode.