Skip to content

Add support for /** comments and multiline // comments. #8

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.

Sign up for GitHub

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

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Add support for /** comments and multiline // comments. #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a543a53
Add support for /** comments and multiline // comments.
MakMuftic Dec 3, 2018
74b06c9
Merge branch 'master' into feature/different-multiline-comments-support
MakMuftic Dec 3, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions src/lib/contract/contract-comment.es6
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,18 @@ export class ContractComment {
let oldCommentPosition = line - 1;
while (true) {
let comment = this.contract.getLineAt(oldCommentPosition).trim();
if (comment.startsWith(parameterCommentRegex)) {
oldCommentsParams.push({line: oldCommentPosition, value: comment});
if (comment.startsWith('/**')) {
// multiline /** comments
return true;
} else if (comment.startsWith(parameterCommentRegex)) {
// param comments
oldCommentsParams.push({ line: oldCommentPosition, value: comment });
} else if (comment.startsWith('//')) {
oldCommentsMap[comment.match(generatedCommentRegex)[0]] = comment;
// other comments
let matchedComment = comment.match(generatedCommentRegex);
if (matchedComment != null) {
oldCommentsMap[matchedComment[0]] = comment;
}
} else if (!comment.startsWith('function')) {
break;
}
Expand Down
15 changes: 14 additions & 1 deletion test/test-contracts/Metacoin.edited.commented.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,19 @@
pragma solidity ^0.4.24;


/// @title MetaCoin v.2
/**
* Different type of comments
* MetaCoin contract is used to....
*/
contract MetaCoin {

/// @notice
mapping (address => uint) balances;

// @notice
// This is multiline comment
mapping (address => uint) tokens;

event Transfer(address _from,address _to, uint _amount);

/// @notice
Expand All @@ -16,6 +23,12 @@ contract MetaCoin {
balances[tx.origin] = 10000;
}

/// @param receiver
/// Another multiline comment, this one is about param receiver
function addToken(address receiver) public {
tokens[receiver] = tokens[receiver] + 1;
}

/// @notice
/// @dev
/// @param receiver
Expand Down
15 changes: 14 additions & 1 deletion test/test-contracts/Metacoin.edited.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,18 @@
pragma solidity ^0.4.24;


/// @title MetaCoin v.2
/**
* Different type of comments
* MetaCoin contract is used to....
*/
contract MetaCoin {

mapping (address => uint) balances;

// @notice
// This is multiline comment
mapping (address => uint) tokens;

event Transfer(address _from,address _to, uint _amount);

/// @notice
Expand All @@ -15,6 +22,12 @@ contract MetaCoin {
balances[tx.origin] = 10000;
}

/// @param receiver
/// Another multiline comment, this one is about param receiver
function addToken(address receiver) public {
tokens[receiver] = tokens[receiver] + 1;
}

/// @notice
/// @dev
/// @param receiver
Expand Down