Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Comments feature #359

Closed
ytrewqytrewqytrewqytrewq1 opened this issue Sep 12, 2018 · 7 comments · Fixed by #1127
Closed

Comments feature #359

ytrewqytrewqytrewqytrewq1 opened this issue Sep 12, 2018 · 7 comments · Fixed by #1127
Assignees
Labels
GUI Issues in jadx-gui module new feature
Milestone

Comments

@ytrewqytrewqytrewqytrewq1

It could be useful the possibility to add inline comments to the decompiled code, to make easier the reversing process.

@jpstotz
Copy link
Collaborator

jpstotz commented Sep 12, 2018

What sorts of comments do you expect? Please give an detailed example.

@ytrewqytrewqytrewqytrewq1
Copy link
Author

Sorry, I'll explain better:
a reverse engineer should be able to add to a specific line a inline/multiline comment which could be rendered as in the following image:

image

it could be linked to the specific line number or to a method and saved or in the jobf file or in an another file so that it could be reloaded when the same apk is reopened.
an action to add a comment could be added to the contextual menu opened when a right click is performed on a line.

an additional feature that I think could be useful is the possibility to refactor directly a method a field or a class using the right click on it. It is faster and intuitive than changing the jobf file.
P.S. maybe this feature should be in a separate issue
P.S.S it could be useful also the possibility to see also the smali code of a decompiled file

@Te-k
Copy link

Te-k commented Sep 5, 2019

Having comments would be really helpful for reversing, 👍 on this feature

@skylot skylot mentioned this issue Sep 10, 2020
@skylot skylot added this to the v1.3.0 milestone Nov 18, 2020
@skylot skylot self-assigned this Nov 18, 2020
@Surendrajat
Copy link
Contributor

@skylot I'd like to add that once someone adds comments to the source, there should be a 'find usage' like sub-view to show all the comments. Please see #1085 for common shortcuts of both of the actions.

@jitcor
Copy link

jitcor commented Feb 25, 2021

image
I hope that Jadx can add comments in places like this and save them permanently in the jobf file. @skylot

@Surendrajat
Copy link
Contributor

@ihbing this is already working, thanks to @skylot :)
Check out https://github.com/skylot/jadx/tree/code-comments branch. I'm hoping this to be merged soon.

@jitcor
Copy link

jitcor commented Mar 1, 2021

@ihbing,由于@skylot:,它已经可以工作了:)
查看https://github.com/skylot/jadx/tree/code-comments分支。我希望很快将其合并。

I tested it and it was very good, thank you.

@skylot skylot mentioned this issue Mar 2, 2021
skylot added a commit that referenced this issue Mar 4, 2021
* feat(gui): add code comments (#359)
* refactor: replace instanceof search with method dispatch in RegionGen
* fix: various bug fixes and improvements for code comments
* fix(gui): support multiline code comments
* fix: resolve code differences after class reload
* fix(gui): add search for comments, allow search in active tab only
* fix: correct search for inner classes
* fix(gui): run full index on search dialog open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
GUI Issues in jadx-gui module new feature
Projects
None yet
Development

Successfully merging a pull request may close this issue.

7 participants