Skip to content

Commit fbe2b7d

Browse files
committed
update readme
1 parent 3bf019a commit fbe2b7d

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,24 @@
11
# DeepCommenter
22

3-
The source code for DeepCommenter.
3+
DeepCommenter is an Intellij IDEA plugin used to generate java code comment automatically.
44

55

66

7-
### How to Use
7+
## Installation
88

9+
1. Download `deepcommenter-client.jar`;
10+
2. Open Intellij IDEA, choose
11+
- Windows:`File` -> `Settings` -> `Plugins`;
12+
13+
- Mac:`IntelliJ IDEA` -> `Preferences` -> `Plugins`;
14+
3. choose `Install Plugin from Disk`;
15+
4. find the path of the jar and install it.
16+
5. Restart Intellij IDEA to activate the plugin.
17+
18+
19+
20+
## Usage
21+
22+
1. Select the java method you want to generate comment for;
23+
2. choose `Code` -> `Generate Comment`;
24+
3. The automatically generated comment will be inserted right above the selected code.

0 commit comments

Comments
 (0)