Skip to content

Commit 9ab3a99

Browse files
David20240718David20240718
committed
feat:add comments to enhance code readability
1 parent 1b650b1 commit 9ab3a99

40 files changed

+54
-48
lines changed

‎.bettercodehub.yml

+2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1+
# Depth of components to analyze (2 levels deep)
12
component_depth: 2
23

4+
# Programming languages to analyze
35
languages:
46
- csharp

‎.gitignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -312,4 +312,4 @@ tools
312312
.idea/.idea.AElf/.idea/projectSettingsUpdater.xml
313313
.idea/.idea.AElf/.idea/vcs.xml
314314
.idea/.idea.AElf/.idea/workspace.xml
315-
.idea/.idea.AElf/riderModule.iml
315+
.idea/.idea.AElf/riderModule.iml

‎.readthedocs.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ sphinx:
1414
# Optionally build your docs in additional formats such as PDF and ePub
1515
formats: all
1616

17-
# Optionally set the version of Python and requirements required to build your docs
17+
# Optionally set the version of python and requirements required to build your docs
1818
python:
1919
version: 3.7
2020
install:

‎AElf.ContractTools.targets

+2-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@
3232
</PropertyGroup>
3333
</Otherwise>
3434
</Choose>
35-
35+
36+
<!-- Generate protobuf code before building and getting the target path -->
3637
<Target Name="GenerateProtobufCode" BeforeTargets="BeforeBuild;GetTargetPath">
3738
<PropertyGroup>
3839
<LocalProtobufDir>$(ProjectDir)/Protobuf</LocalProtobufDir>

‎AElf.Contracts.sln

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
2-
Microsoft Visual Studio Solution File, Format Version 12.00
1+
Microsoft Visual Studio Solution File, Format Version 12.00
32
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "contract", "contract", "{651F0F6E-86CF-42D2-9110-5F3EAE5704F0}"
43
EndProject
54
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "test", "test", "{26990847-E0A2-4FCC-8C71-267CA77557CD}"

‎AElf.sln.DotSettings

+16-13
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
1-
<wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
1+
<wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
2+
xmlns:s="clr-namespace:System;assembly=mscorlib"
3+
xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml"
4+
xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
25
<s:Boolean x:Key="/Default/CodeEditing/SuppressNullableWarningFix/Enabled/@EntryValue">False</s:Boolean>
3-
<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=JS/@EntryIndexedValue">JS</s:String>
4-
<s:Boolean x:Key="/Default/UserDictionary/Words/=aelf/@EntryIndexedValue">True</s:Boolean>
5-
<s:Boolean x:Key="/Default/UserDictionary/Words/=appsettings/@EntryIndexedValue">True</s:Boolean>
6-
<s:Boolean x:Key="/Default/UserDictionary/Words/=blockchain/@EntryIndexedValue">True</s:Boolean>
7-
<s:Boolean x:Key="/Default/UserDictionary/Words/=Blockchains/@EntryIndexedValue">True</s:Boolean>
8-
<s:Boolean x:Key="/Default/UserDictionary/Words/=DPOS/@EntryIndexedValue">True</s:Boolean>
9-
<s:Boolean x:Key="/Default/UserDictionary/Words/=grpc/@EntryIndexedValue">True</s:Boolean>
10-
<s:Boolean x:Key="/Default/UserDictionary/Words/=hangfire/@EntryIndexedValue">True</s:Boolean>
11-
<s:Boolean x:Key="/Default/UserDictionary/Words/=Merkle/@EntryIndexedValue">True</s:Boolean>
12-
<s:Boolean x:Key="/Default/UserDictionary/Words/=pubkey/@EntryIndexedValue">True</s:Boolean>
13-
<s:Boolean x:Key="/Default/UserDictionary/Words/=Ssdb/@EntryIndexedValue">True</s:Boolean>
14-
<s:Boolean x:Key="/Default/UserDictionary/Words/=Xunit/@EntryIndexedValue">True</s:Boolean></wpf:ResourceDictionary>
6+
<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=JS/@EntryIndexedValue">JS</s:String>
7+
<s:Boolean x:Key="/Default/UserDictionary/Words/=aelf/@EntryIndexedValue">True</s:Boolean>
8+
<s:Boolean x:Key="/Default/UserDictionary/Words/=appsettings/@EntryIndexedValue">True</s:Boolean>
9+
<s:Boolean x:Key="/Default/UserDictionary/Words/=blockchain/@EntryIndexedValue">True</s:Boolean>
10+
<s:Boolean x:Key="/Default/UserDictionary/Words/=Blockchains/@EntryIndexedValue">True</s:Boolean>
11+
<s:Boolean x:Key="/Default/UserDictionary/Words/=DPOS/@EntryIndexedValue">True</s:Boolean>
12+
<s:Boolean x:Key="/Default/UserDictionary/Words/=grpc/@EntryIndexedValue">True</s:Boolean>
13+
<s:Boolean x:Key="/Default/UserDictionary/Words/=hangfire/@EntryIndexedValue">True</s:Boolean>
14+
<s:Boolean x:Key="/Default/UserDictionary/Words/=Merkle/@EntryIndexedValue">True</s:Boolean>
15+
<s:Boolean x:Key="/Default/UserDictionary/Words/=pubkey/@EntryIndexedValue">True</s:Boolean>
16+
<s:Boolean x:Key="/Default/UserDictionary/Words/=Ssdb/@EntryIndexedValue">True</s:Boolean>
17+
<s:Boolean x:Key="/Default/UserDictionary/Words/=Xunit/@EntryIndexedValue">True</s:Boolean></wpf:ResourceDictionary>

‎CodeCoverage.runsettings

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
<?xml version="1.0" encoding="utf-8"?>
2+
<!-- This XML defines run settings for code coverage. -->
23
<!-- File name extension must be .runsettings -->
34
<RunSettings>
45
<DataCollectionRunSettings>

‎appveyor.yml

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
# appveyor configuration file
12
version: 1.0.0.{build}
23
skip_tags: true
34
os: Windows Server 2012 R2

‎azure-myget-publish.yml

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
# Azure DevOps pipeline configuration for publishing NuGet packages to MyGet
12
pool:
23
vmImage: ubuntu-latest
34
pr: none

‎azure-pipelines.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# File: azure-pipelines.yml
1+
# Azure Pipelines configuration file
22
jobs:
33
- template: templates/build-template-window.yml
44
parameters:

‎build.cake

-1
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,6 @@ Task("Test-with-Codecov")
112112
actions.Add(action);
113113
}
114114

115-
116115
var options = new ParallelOptions {
117116
MaxDegreeOfParallelism = 1,
118117
//CancellationToken = cancellationToken

‎build.config

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
#!/usr/bin/env bash
22
CAKE_VERSION=0.37.0
3-
DOTNET_VERSION=6.0.300
3+
DOTNET_VERSION=6.0.300

‎build.ps1

+1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ $PSScriptRoot = Split-Path $MyInvocation.MyCommand.Path -Parent
66

77
[string] $CakeVersion = ''
88
[string] $DotNetVersion= ''
9+
910
foreach($line in Get-Content (Join-Path $PSScriptRoot 'build.config'))
1011
{
1112
if ($line -like 'CAKE_VERSION=*') {

‎build.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
#!/usr/bin/env bash
2-
# Define varibles
2+
# Define variables
33
SCRIPT_DIR=$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )
44
source $SCRIPT_DIR/build.config
55
TOOLS_DIR=$SCRIPT_DIR/tools

‎common.props

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,4 @@
1111
<None Include="../../LICENSE" Pack="true" PackagePath=""/>
1212
</ItemGroup>
1313

14-
</Project>
14+
</Project>

‎docker/docker-compose.yml

-1
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,3 @@ services:
99
- 8001:8000
1010
volumes:
1111
- /opt:/opt
12-

‎docker/start-cli.sh

-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,3 @@
22
BIND_VOLUME='-v /opt:/opt'
33
CONFIGURE_PATH='-w /opt/aelf-node'
44
docker run -it --rm $BIND_VOLUME $CONFIGURE_PATH aelf/node
5-

‎docker/start-node.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22
PUBLISH_PORT='-p 6800:6800 -p 8000:8000'
33
BIND_VOLUME='-v /opt:/opt'
44
CONfIGURE_PATH='/opt/aelf-node'
5-
docker run -itd $PUBLISH_PORT $BIND_VOLUME -w $CONfIGURE_PATH aelf/node dotnet /app/AElf.Launcher.dll --config.path $CONfIGURE_PATH
5+
docker run -itd $PUBLISH_PORT $BIND_VOLUME -w $CONfIGURE_PATH aelf/node dotnet /app/AElf.Launcher.dll --config.path $CONfIGURE_PATH

‎docs-sphinx/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -78,4 +78,4 @@ Welcome to AElf's official documentation!
7878

7979
tutorials/cross-chain/running-side-chain
8080
tutorials/__run-node
81-
getting-started/smart-contract-development/developing-smart-contracts/index
81+
getting-started/smart-contract-development/developing-smart-contracts/index

‎docs/main-structure.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -88,4 +88,4 @@
8888
* [Google cloud](resources/cloud/gcp/GCP.md)
8989
* [Browser Extension](resources/browser-extension.md)
9090
* [Joining AElf's testnet](resources/testnet.md)
91-
* [Running a side chain](tutorials/cross-chain/running-side-chain.md)
91+
* [Running a side chain](tutorials/cross-chain/running-side-chain.md)

‎scripts/build.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ dotnet build /clp:ErrorsOnly /p:GeneratePackageOnBuild=false -v quiet "AElf.All.
66
if [[ $? -ne 0 ]] ; then
77
echo "Build failed."
88
exit 1
9-
fi
9+
fi

‎scripts/deploy_docker.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@ docker build -t aelf/node:${TAG} ~/aelf/.
1313
docker tag aelf/node:${TAG} aelf/node:latest
1414
docker login -u="$DOCKER_USERNAME" -p="$DOCKER_PASSWORD"
1515
docker push aelf/node:${TAG}
16-
docker push aelf/node:latest
16+
docker push aelf/node:latest

‎scripts/deploy_myget.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,4 @@ do
3131
fi
3232
done
3333
cd ../
34-
done
34+
done

‎scripts/deploy_myget_daily.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,4 +34,4 @@ do
3434
fi
3535
done
3636
cd ../
37-
done
37+
done

‎scripts/deploy_nuget.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,4 @@ do
3131
fi
3232
done
3333
cd ../
34-
done
34+
done

‎scripts/download_binary.bat

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@ if not exist "%scriptdir%contract_csharp_plugin.exe" (
1313
)
1414
echo "unzip file: %file%"
1515
unzip %scriptdir%%filename% -d %scriptdir%
16-
)
16+
)

‎scripts/download_binary.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,4 @@ if [[ ! -f ${plugin} ]]; then
3030

3131
# Unzip
3232
unzip -o ${filename} -d "${scriptdir}"
33-
fi
33+
fi

‎scripts/generate_contract_base.bat

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ protoc --proto_path=../../protobuf ^
88
--contract_opt=%2,nocontract ^
99
--contract_out=./Protobuf/Generated ^
1010
--plugin=protoc-gen-contract="%scriptdir%contract_csharp_plugin.exe" ^
11-
%1
11+
%1

‎scripts/generate_contract_base.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@ protoc --proto_path=${solutiondir}/protobuf \
1313
--contract_opt="$2",nocontract \
1414
--contract_out=./Protobuf/Generated \
1515
--plugin=protoc-gen-contract=${plugin} \
16-
$1
16+
$1

‎scripts/generate_contract_code.bat

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ protoc --proto_path=../../protobuf ^
77
--csharp_opt=file_extension=.g.cs ^
88
--contract_out=./Protobuf/Generated ^
99
--plugin=protoc-gen-contract="%scriptdir%contract_csharp_plugin.exe" ^
10-
%*
10+
%*

‎scripts/generate_contract_code.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,4 @@ protoc --proto_path=${solutiondir}/protobuf \
1212
--csharp_opt=file_extension=.g.cs \
1313
--contract_out=./Protobuf/Generated \
1414
--plugin=protoc-gen-contract=${plugin} \
15-
$@
15+
$@

‎scripts/generate_contract_reference.bat

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ protoc --proto_path=../../protobuf ^
88
--contract_opt=reference ^
99
--contract_out=internal_access:./Protobuf/Generated ^
1010
--plugin=protoc-gen-contract="%scriptdir%contract_csharp_plugin.exe" ^
11-
%*
11+
%*

‎scripts/generate_contract_reference.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@ protoc --proto_path=${solutiondir}/protobuf \
1313
--contract_opt=reference \
1414
--contract_out=internal_access:./Protobuf/Generated \
1515
--plugin=protoc-gen-contract="${plugin}" \
16-
$@
16+
$@

‎scripts/generate_contract_stub.bat

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@ protoc --proto_path=../../protobuf ^
99
--contract_opt=internal_access ^
1010
--contract_out=./Protobuf/Generated ^
1111
--plugin=protoc-gen-contract="%scriptdir%contract_csharp_plugin.exe" ^
12-
%*
12+
%*

‎scripts/generate_contract_stub.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@ protoc --proto_path=${solutiondir}/protobuf \
1818
--contract_opt=internal_access \
1919
--contract_out=${destdir} \
2020
--plugin=protoc-gen-contract="${plugin}" \
21-
$@
21+
$@

‎scripts/generate_event_only.bat

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ protoc --proto_path=../../protobuf ^
88
--contract_opt=nocontract ^
99
--contract_out=internal_access:./Protobuf/Generated ^
1010
--plugin=protoc-gen-contract="%scriptdir%contract_csharp_plugin.exe" ^
11-
%*
11+
%*

‎scripts/generate_event_only.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@ protoc --proto_path=${solutiondir}/protobuf \
1313
--contract_opt=nocontract \
1414
--contract_out=internal_access:./Protobuf/Generated \
1515
--plugin=protoc-gen-contract=${plugin} \
16-
$@
16+
$@

‎scripts/install_protobuf.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,4 +35,4 @@ elif [[ ${osn} == "linux" ]]; then
3535
# Optional: change owner
3636
sudo chown ${USER} /usr/local/bin/protoc
3737
sudo chown -R ${USER} /usr/local/include/google
38-
fi
38+
fi

‎scripts/test.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,4 @@ for i in *Tests ; do
2020

2121
echo "Test Run Successful."
2222

23-
done
23+
done

‎scripts/upload_coverage.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22

33
curl -s https://codecov.io/bash > codecov
44
chmod +x codecov
5-
./codecov -f "../test/results/coverage.opencover.xml" -t $1
5+
./codecov -f "../test/results/coverage.opencover.xml" -t $1

0 commit comments

Comments
 (0)