Wetenschap
beschrijvende namen:
* calculate_lift_energy: Eenvoudig en beschrijft duidelijk het doel van de functie.
* energie_to_lift_box: Benadrukt het type energie dat wordt berekend en het object dat wordt opgeheven.
* potential_energy_from_weight: Deze naam verduidelijkt dat de functie de potentiële energie berekent die wordt verkregen door de doos op te tillen.
Kortere namen:
* lift_energy: Beknopt en nog steeds begrijpelijk.
* box_lift_energy: Iets specifieker dan "lift_energy."
* potential_energy: Als de context duidelijk is, kunt u eenvoudig "potential_energy" gebruiken.
Overwegingen:
* context: De beste naam hangt af van de context van uw code. Als het deel uitmaakt van een groter systeem, is het handig om namen te gebruiken die aansluiten bij de algemene naamgevingsconventies.
* Duidelijkheid: De naam moet duidelijk en gemakkelijk te begrijpen zijn zonder te moeten verwijzen naar de documentatie van de functie.
* beknoptheid: Houd namen beknopt, maar niet zo kort dat ze dubbelzinnig worden.
Voorbeeld:
`` `Python
def calculaat_lift_energy (gewicht, hoogte):
"" "Berekent de energie die nodig is om een doos op een bepaalde hoogte te tillen.
Args:
Gewicht:het gewicht van de doos in kilogram.
Hoogte:de hoogte van de doos wordt in meters opgetild.
Retourneert:
De energie die nodig is om de doos in joules op te tillen.
"" "
Retourgewicht * 9.81 * Hoogte
`` `
Uiteindelijk is de beste naam degene die het doel van de functie het beste communiceert aan de lezer.
Wetenschap © https://nl.scienceaq.com