...
Eroare Solidity · Erori de sintaxă, pragma și licență

DocstringParsingError: Documented parameter "suma" not found in the parameter list of the function.

Pe scurt

Comentariul NatSpec (/// @param suma) descrie un parametru care nu există în funcție: parametrul a fost redenumit sau șters, iar documentația a rămas veche. Fă numele din @param identic cu cel din semnătura funcției.

Explicat de Tudor Andrei Dumitrescu, Senior Software Developer, fondatorul Academiei ProgramatorilorActualizat la

Ce înseamnă

Comentariile care încep cu /// sau /** */ sunt NatSpec: documentația oficială a contractului, pe care compilatorul o citește și o verifică. Pentru fiecare @param nume, compilatorul caută un parametru cu exact acel nume în funcția de dedesubt. Dacă nu îl găsește, compilarea se oprește cu DocstringParsingError, chiar dacă restul codului e corect.

Aproape mereu e o redenumire făcută doar pe jumătate: ai schimbat suma în valoare în semnătură, dar nu și în comentariu. Sau ai copiat comentariul de la altă funcție.

O eroare înrudită apare la valorile întoarse: Documentation tag "@return total" exceeds the number of return parameters. înseamnă că ai mai multe @return decât valori în returns (...), sau că funcția nu întoarce nimic. Linia din mesaj arată comentariul, nu funcția.

De ce apare: cauzele frecvente

1Parametru redenumit, comentariu vechi

Greșit
SOLIDITY
/// @param suma valoarea de dublat
function dublu(uint256 valoare) external pure returns (uint256) {
    return valoare * 2;
}
Corect
SOLIDITY
/// @param valoare valoarea de dublat
function dublu(uint256 valoare) external pure returns (uint256) {
    return valoare * 2;
}

Numele din @param trebuie să fie exact numele parametrului.

2@return la o funcție care nu întoarce nimic

Greșit
SOLIDITY
/// @return total noul total
function adauga(uint256 x) external {
    total += x;
}
Corect
SOLIDITY
/// @notice Adauga x la total
function adauga(uint256 x) external {
    total += x;
}

@return e verificat față de lista returns (...); fără valori întoarse, tag-ul nu are ce descrie.

Repară tu

Repară eroarea, direct în pagină

Contractul Calculator are o funcție documentată cu NatSpec, dar compilarea dă DocstringParsingError: Documented parameter "suma" not found in the parameter list of the function. Documentația e cea corectă: redenumește parametrul funcției în suma (și în corpul ei). Scriptul afișează dublul lui 21.

Codul care dă eroarea
SOLIDITY
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.20;

contract Calculator {
    /// @notice Dubleaza o suma
    /// @param suma valoarea de dublat
    /// @return dublul sumei
    function dublu(uint256 valoare) external pure returns (uint256) {
        return valoare * 2;
    }
}
După reparație, programul afișează
Dublu: 42
Indiciu

Numele din @param trebuie să apară exact în semnătura funcției.

Alte forme ale mesajului

  • DocstringParsingError: Documented parameter "y" not found in the parameter list of the function.
  • DocstringParsingError: Documentation tag "@return total" exceeds the number of return parameters.

Cum o eviți pe viitor

  • Când redenumești un parametru, folosește redenumirea din editor (Rename Symbol), nu căutare și înlocuire parțială.
  • Scrie NatSpec după ce semnătura funcției s-a stabilizat.
  • Recitește comentariul când copiezi o funcție ca șablon pentru alta.
  • Ține un @param pentru fiecare parametru și un @return pentru fiecare valoare întoarsă.

Întrebări frecvente

De ce oprește compilarea un comentariu?

Comentariile /// nu sunt simple comentarii: din ele se generează documentația pentru utilizatori și dezvoltatori (devdoc, userdoc), pe care o afișează portofelele și exploratoarele de blocuri. Compilatorul vrea ca ea să fie corectă. Comentariile // obișnuite nu sunt verificate.

Pot scăpa de eroare schimbând /// în //?

Da, dar pierzi documentația. Reparația bună e să potrivești numele.

Erori înrudite

← Toate erorile Solidity

Tudor Andrei Dumitrescu
Cine a explicat eroarea

Tudor Andrei Dumitrescu

Senior Software Developer · fondatorul Academiei Programatorilor

LinkedIn
  1. 2019 Junior JavaCognizant Softvision
  2. 2021 Mid JavaCognizant Softvision
  3. 2022 Team LeaderEndava
  4. 2023 Senior Software DeveloperUniCredit
  5. Acum Senior Software DeveloperHCLTech
Certificat de absolvire Instructor / Preparator formare, Tudor Andrei Dumitrescu
Certificat de formator autorizatMinisterul Muncii și Ministerul Educației · 2022
Certificat de absolvire Instructor / Preparator formare, Tudor Andrei Dumitrescu

Certificat de formator autorizat · Ministerul Muncii și Ministerul Educației · 2022

Din 2020 construiește Academia Programatorilor, iar din 2026 și JoburiIT.ro. Fiecare eroare de aici a fost reprodusă în editorul nostru: codul greșit chiar dă mesajul din titlu, iar reparația chiar funcționează.

Învață Solidity de la zero, cu exerciții la fiecare lecție

Curs Solidity și Smart Contracts: lecții scurte, fiecare cu un exercițiu verificat automat, direct în browser. Primele 15 lecții sunt gratuite.