feat:add comments to enhance code readability

.bettercodehub.yml

@@ -1,4 +1,6 @@
+# Depth of components to analyze (2 levels deep)
 component_depth: 2
 
+# Programming languages to analyze
 languages:
 - csharp

.gitignore

@@ -312,4 +312,4 @@ tools
 .idea/.idea.AElf/.idea/projectSettingsUpdater.xml
 .idea/.idea.AElf/.idea/vcs.xml
 .idea/.idea.AElf/.idea/workspace.xml
-.idea/.idea.AElf/riderModule.iml
+.idea/.idea.AElf/riderModule.iml

.readthedocs.yml

@@ -14,7 +14,7 @@ sphinx:
 # Optionally build your docs in additional formats such as PDF and ePub
 formats: all
 
-# Optionally set the version of Python and requirements required to build your docs
+# Optionally set the version of python and requirements required to build your docs
 python:
   version: 3.7
   install:

AElf.ContractTools.targets

@@ -32,7 +32,8 @@
             </PropertyGroup>
         </Otherwise>
     </Choose>
-
+
+    <!-- Generate protobuf code before building and getting the target path -->
     <Target Name="GenerateProtobufCode" BeforeTargets="BeforeBuild;GetTargetPath">
         <PropertyGroup>
             <LocalProtobufDir>$(ProjectDir)/Protobuf</LocalProtobufDir>

AElf.Contracts.sln

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

AElf.sln.DotSettings

@@ -1,14 +1,17 @@
-<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">
+<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">
 	<s:Boolean x:Key="/Default/CodeEditing/SuppressNullableWarningFix/Enabled/@EntryValue">False</s:Boolean>
-	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=JS/@EntryIndexedValue">JS</s:String>
-	<s:Boolean x:Key="/Default/UserDictionary/Words/=aelf/@EntryIndexedValue">True</s:Boolean>
-	<s:Boolean x:Key="/Default/UserDictionary/Words/=appsettings/@EntryIndexedValue">True</s:Boolean>
-	<s:Boolean x:Key="/Default/UserDictionary/Words/=blockchain/@EntryIndexedValue">True</s:Boolean>
-	<s:Boolean x:Key="/Default/UserDictionary/Words/=Blockchains/@EntryIndexedValue">True</s:Boolean>
-	<s:Boolean x:Key="/Default/UserDictionary/Words/=DPOS/@EntryIndexedValue">True</s:Boolean>
-	<s:Boolean x:Key="/Default/UserDictionary/Words/=grpc/@EntryIndexedValue">True</s:Boolean>
-	<s:Boolean x:Key="/Default/UserDictionary/Words/=hangfire/@EntryIndexedValue">True</s:Boolean>
-	<s:Boolean x:Key="/Default/UserDictionary/Words/=Merkle/@EntryIndexedValue">True</s:Boolean>
-	<s:Boolean x:Key="/Default/UserDictionary/Words/=pubkey/@EntryIndexedValue">True</s:Boolean>
-	<s:Boolean x:Key="/Default/UserDictionary/Words/=Ssdb/@EntryIndexedValue">True</s:Boolean>
-	<s:Boolean x:Key="/Default/UserDictionary/Words/=Xunit/@EntryIndexedValue">True</s:Boolean></wpf:ResourceDictionary>
+    <s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=JS/@EntryIndexedValue">JS</s:String>
+    <s:Boolean x:Key="/Default/UserDictionary/Words/=aelf/@EntryIndexedValue">True</s:Boolean>
+    <s:Boolean x:Key="/Default/UserDictionary/Words/=appsettings/@EntryIndexedValue">True</s:Boolean>
+    <s:Boolean x:Key="/Default/UserDictionary/Words/=blockchain/@EntryIndexedValue">True</s:Boolean>
+    <s:Boolean x:Key="/Default/UserDictionary/Words/=Blockchains/@EntryIndexedValue">True</s:Boolean>
+    <s:Boolean x:Key="/Default/UserDictionary/Words/=DPOS/@EntryIndexedValue">True</s:Boolean>
+    <s:Boolean x:Key="/Default/UserDictionary/Words/=grpc/@EntryIndexedValue">True</s:Boolean>
+    <s:Boolean x:Key="/Default/UserDictionary/Words/=hangfire/@EntryIndexedValue">True</s:Boolean>
+    <s:Boolean x:Key="/Default/UserDictionary/Words/=Merkle/@EntryIndexedValue">True</s:Boolean>
+    <s:Boolean x:Key="/Default/UserDictionary/Words/=pubkey/@EntryIndexedValue">True</s:Boolean>
+    <s:Boolean x:Key="/Default/UserDictionary/Words/=Ssdb/@EntryIndexedValue">True</s:Boolean>
+    <s:Boolean x:Key="/Default/UserDictionary/Words/=Xunit/@EntryIndexedValue">True</s:Boolean></wpf:ResourceDictionary>

CodeCoverage.runsettings

@@ -1,4 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
+<!-- This XML defines run settings for code coverage. -->
 <!-- File name extension must be .runsettings -->
 <RunSettings>
   <DataCollectionRunSettings>

appveyor.yml

@@ -1,3 +1,4 @@
+# appveyor configuration file
 version: 1.0.0.{build}
 skip_tags: true
 os: Windows Server 2012 R2

azure-myget-publish.yml

@@ -1,3 +1,4 @@
+  # Azure DevOps pipeline configuration for publishing NuGet packages to MyGet
   pool:
     vmImage: ubuntu-latest
   pr: none 

azure-pipelines.yml

@@ -1,4 +1,4 @@
-# File: azure-pipelines.yml
+# Azure Pipelines configuration file
 jobs:
   - template: templates/build-template-window.yml
     parameters:

build.cake

@@ -112,7 +112,6 @@ Task("Test-with-Codecov")
         actions.Add(action);
     }
 
-
     var options = new ParallelOptions {
         MaxDegreeOfParallelism = 1,
         //CancellationToken = cancellationToken

build.config

@@ -1,3 +1,3 @@
 #!/usr/bin/env bash
 CAKE_VERSION=0.37.0
-DOTNET_VERSION=6.0.300
+DOTNET_VERSION=6.0.300

build.ps1

@@ -6,6 +6,7 @@ $PSScriptRoot = Split-Path $MyInvocation.MyCommand.Path -Parent
 
 [string] $CakeVersion = ''
 [string] $DotNetVersion= ''
+
 foreach($line in Get-Content (Join-Path $PSScriptRoot 'build.config'))
 {
   if ($line -like 'CAKE_VERSION=*') {

build.sh

@@ -1,5 +1,5 @@
 #!/usr/bin/env bash
-# Define varibles
+# Define variables
 SCRIPT_DIR=$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )
 source $SCRIPT_DIR/build.config
 TOOLS_DIR=$SCRIPT_DIR/tools

common.props

@@ -11,4 +11,4 @@
     <None Include="../../LICENSE" Pack="true" PackagePath=""/>
   </ItemGroup>
 
-</Project>
+</Project>

docker/docker-compose.yml

@@ -9,4 +9,3 @@ services:
       - 8001:8000
     volumes:
       - /opt:/opt
-

docker/start-cli.sh

@@ -2,4 +2,3 @@
 BIND_VOLUME='-v /opt:/opt'
 CONFIGURE_PATH='-w /opt/aelf-node'
 docker run -it --rm   $BIND_VOLUME $CONFIGURE_PATH   aelf/node
-

docker/start-node.sh

@@ -2,4 +2,4 @@
 PUBLISH_PORT='-p 6800:6800 -p 8000:8000'
 BIND_VOLUME='-v /opt:/opt'
 CONfIGURE_PATH='/opt/aelf-node'
-docker run -itd $PUBLISH_PORT  $BIND_VOLUME -w  $CONfIGURE_PATH  aelf/node  dotnet /app/AElf.Launcher.dll  --config.path $CONfIGURE_PATH
+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

@@ -78,4 +78,4 @@ Welcome to AElf's official documentation!
 
    tutorials/cross-chain/running-side-chain
    tutorials/__run-node
-   getting-started/smart-contract-development/developing-smart-contracts/index
+   getting-started/smart-contract-development/developing-smart-contracts/index

docs/main-structure.md

@@ -88,4 +88,4 @@
       * [Google cloud](resources/cloud/gcp/GCP.md)
     * [Browser Extension](resources/browser-extension.md)
     * [Joining AElf's testnet](resources/testnet.md)
-    * [Running a side chain](tutorials/cross-chain/running-side-chain.md)
+    * [Running a side chain](tutorials/cross-chain/running-side-chain.md)

scripts/build.sh

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

scripts/deploy_docker.sh

@@ -13,4 +13,4 @@ docker build -t aelf/node:${TAG} ~/aelf/.
 docker tag aelf/node:${TAG} aelf/node:latest
 docker login -u="$DOCKER_USERNAME" -p="$DOCKER_PASSWORD"
 docker push aelf/node:${TAG}
-docker push aelf/node:latest
+docker push aelf/node:latest

scripts/deploy_myget.sh

@@ -31,4 +31,4 @@ do
         fi
     done
     cd ../
-done
+done

scripts/deploy_myget_daily.sh

@@ -34,4 +34,4 @@ do
         fi
     done
     cd ../
-done
+done

scripts/deploy_nuget.sh

@@ -31,4 +31,4 @@ do
         fi
     done
     cd ../
-done
+done

scripts/download_binary.bat

@@ -13,4 +13,4 @@ if not exist "%scriptdir%contract_csharp_plugin.exe" (
     )
     echo "unzip file: %file%"
     unzip %scriptdir%%filename% -d %scriptdir%
-)
+)

scripts/download_binary.sh

@@ -30,4 +30,4 @@ if [[ ! -f ${plugin} ]]; then
 
     # Unzip
     unzip -o ${filename} -d "${scriptdir}"
-fi
+fi

scripts/generate_contract_base.bat

@@ -8,4 +8,4 @@ protoc --proto_path=../../protobuf ^
 --contract_opt=%2,nocontract ^
 --contract_out=./Protobuf/Generated ^
 --plugin=protoc-gen-contract="%scriptdir%contract_csharp_plugin.exe" ^
-%1
+%1

scripts/generate_contract_base.sh

@@ -13,4 +13,4 @@ protoc --proto_path=${solutiondir}/protobuf \
 --contract_opt="$2",nocontract \
 --contract_out=./Protobuf/Generated \
 --plugin=protoc-gen-contract=${plugin} \
-$1
+$1

scripts/generate_contract_code.bat

@@ -7,4 +7,4 @@ protoc --proto_path=../../protobuf ^
 --csharp_opt=file_extension=.g.cs ^
 --contract_out=./Protobuf/Generated ^
 --plugin=protoc-gen-contract="%scriptdir%contract_csharp_plugin.exe" ^
-%*
+%*

scripts/generate_contract_code.sh

@@ -12,4 +12,4 @@ protoc --proto_path=${solutiondir}/protobuf \
 --csharp_opt=file_extension=.g.cs \
 --contract_out=./Protobuf/Generated \
 --plugin=protoc-gen-contract=${plugin} \
-$@
+$@

scripts/generate_contract_reference.bat

@@ -8,4 +8,4 @@ protoc --proto_path=../../protobuf ^
 --contract_opt=reference ^
 --contract_out=internal_access:./Protobuf/Generated ^
 --plugin=protoc-gen-contract="%scriptdir%contract_csharp_plugin.exe" ^
-%*
+%*

scripts/generate_contract_reference.sh

@@ -13,4 +13,4 @@ protoc --proto_path=${solutiondir}/protobuf \
 --contract_opt=reference \
 --contract_out=internal_access:./Protobuf/Generated \
 --plugin=protoc-gen-contract="${plugin}" \
-$@
+$@

scripts/generate_contract_stub.bat

@@ -9,4 +9,4 @@ protoc --proto_path=../../protobuf ^
 --contract_opt=internal_access ^
 --contract_out=./Protobuf/Generated ^
 --plugin=protoc-gen-contract="%scriptdir%contract_csharp_plugin.exe" ^
-%*
+%*

scripts/generate_contract_stub.sh

@@ -18,4 +18,4 @@ protoc --proto_path=${solutiondir}/protobuf \
 --contract_opt=internal_access \
 --contract_out=${destdir} \
 --plugin=protoc-gen-contract="${plugin}" \
-$@
+$@

scripts/generate_event_only.bat

@@ -8,4 +8,4 @@ protoc --proto_path=../../protobuf ^
 --contract_opt=nocontract ^
 --contract_out=internal_access:./Protobuf/Generated ^
 --plugin=protoc-gen-contract="%scriptdir%contract_csharp_plugin.exe" ^
-%*
+%*

scripts/generate_event_only.sh

@@ -13,4 +13,4 @@ protoc --proto_path=${solutiondir}/protobuf \
 --contract_opt=nocontract \
 --contract_out=internal_access:./Protobuf/Generated \
 --plugin=protoc-gen-contract=${plugin} \
-$@
+$@

scripts/install_protobuf.sh

@@ -35,4 +35,4 @@ elif [[ ${osn} == "linux" ]]; then
     # Optional: change owner
     sudo chown ${USER} /usr/local/bin/protoc
     sudo chown -R ${USER} /usr/local/include/google
-fi
+fi

scripts/test.sh

@@ -20,4 +20,4 @@ for i in *Tests ; do
 
   echo "Test Run Successful."
 
-done
+done

scripts/upload_coverage.sh

@@ -2,4 +2,4 @@
 
 curl -s https://codecov.io/bash > codecov
 chmod +x codecov
-./codecov -f "../test/results/coverage.opencover.xml" -t $1
+./codecov -f "../test/results/coverage.opencover.xml" -t $1