Išvalykite šiukšles  TL;DR: pašalinkite nenaudojamas funkcijas, konstantas ir „tik atvejui“ kodą.  Išspręstos problemos   Miręs kodas  Kodas tik tuo atveju  Sumažintas techninis aptarnavimas   Inkaro valtys  Kognityvinė apkrova  Susiję kodo kvapai   https://hackernoon.com/how-to-find-the-stinky-parts-of-your-code-part-ii-o96s3wl4?embedable=true   https://hackernoon.com/how-to-find-the-stinky-parts-of-your-code-part-xi-sit35t1?embedable=true   https://hackernoon.com/how-to-find-the-stinky-parts-of-your-code-part-xxx?embedable=true  Žingsniai  Įsitikinkite, kad jūsų kodas turi gerą funkcinę aprėptį.  Peržiūrėdami kodą arba naudodami statinės analizės įrankius, nustatykite nenaudojamas funkcijas ir konstantas.  Tik tuo atveju išanalizuokite pridėtą spekuliacinį kodą.  Pašalinkite viską, kas nereikalinga ar nenaudojama.  Atlikite išsamų savo kodo regresijos testą.  Kodo pavyzdys  Prieš   from flask import Flask, jsonify, make_response app = Flask(__name__) HTTP_100_CONTINUE = 100 HTTP_202_ACCEPTED = 202 # Not used HTTP_204_NO_CONTENT = 204 # Not Used HTTP_302_FOUND = 302 # Not Used HTTP_400_BAD_REQUEST = 400 # Not Used HTTP_401_UNAUTHORIZED = 401 # Not Used HTTP_403_FORBIDDEN = 403 HTTP_404_NOT_FOUND = 404 HTTP_410_GONE = 410 HTTP_500_INTERNAL_SERVER_ERROR = 500 HTTP_501_NOT_IMPLEMENTED = 501 probe_telemetry = { "temperature": {"solar_panels": 150, "instrument_1": 50}, "position": {"x": 1000000, "y": 2000000, "z": 3000000, "velocity": {"vx": 100, "vy": 200, "vz": 300}}, "status": {"power_level": 95, "communication_status": "OK"} } @app.route('/api/v1/probe/telemetry', methods=['GET']) def get_telemetry(): return jsonify(probe_telemetry), HTTP_200_OK # The following function is not invoked # and not implemented # It is a dead placeholder @app.route('/api/v1/probe/send_command', methods=['POST']) def send_command(): return jsonify( {"message": "Command endpoint not implemented yet."} ), HTTP_501_NOT_IMPLEMENTED @app.route('/api/v1/probe/data', methods=['GET']) def get_data(): return jsonify({"message": "Data not found"}), HTTP_404_NOT_FOUND @app.route('/api/v1/probe/redirect', methods=['GET']) def redirect_endpoint(): response = make_response( jsonify({"message": "Redirecting..."}), HTTP_301_MOVED_PERMANENTLY ) response.headers['Location'] = '/api/v1/probe/telemetry' return response @app.route('/api/v1/probe/not_modified', methods=['GET']) def not_modified_endpoint(): response = make_response(jsonify({"message": "Not Modified"}), HTTP_304_NOT_MODIFIED) response.headers['ETag'] = 'some_etag' return response @app.route('/api/v1/probe/gone', methods=['GET']) def gone_endpoint(): return jsonify( {"message": "Resource permanently gone"} ), HTTP_410_GONE  Po to   # 1. Ensure your code has good functional coverage. from flask import Flask, jsonify, make_response from http import HTTPStatus app = Flask(__name__) # 2. Identify unused functions and constants # by reviewing your code or using static analysis tools. HTTP_200_OK = HTTPStatus.OK HTTP_301_MOVED_PERMANENTLY = HTTPStatus.MOVED_PERMANENTLY HTTP_304_NOT_MODIFIED = HTTPStatus.NOT_MODIFIED HTTP_404_NOT_FOUND = HTTPStatus.NOT_FOUND HTTP_410_GONE = HTTPStatus.GONE HTTP_501_NOT_IMPLEMENTED = HTTPStatus.NOT_IMPLEMENTED probe_telemetry = { "temperature": {"solar_panels": 150, "instrument_1": 50}, "position": {"x": 1000000, "y": 2000000, "z": 3000000, "velocity": {"vx": 100, "vy": 200, "vz": 300}}, "status": {"power_level": 95, "communication_status": "OK"} } @app.route('/api/v1/probe/telemetry', methods=['GET']) def get_telemetry(): return jsonify(probe_telemetry), HTTP_200_OK # 3. Analyze the added speculative code, just in case. @app.route('/api/v1/probe/send_command', methods=['POST']) def send_command(): return jsonify({"message": "Command endpoint not implemented yet."}), HTTP_501_NOT_IMPLEMENTED @app.route('/api/v1/probe/data', methods=['GET']) def get_data(): return jsonify({"message": "Data not found"}), HTTP_404_NOT_FOUND # 4. Remove anything unnecessary or unused. # 5. Perform comprehensive regression testing on your code.  Tipas    Pusiau automatinis [x]  Galite atlikti kūdikio veiksmus ir pašalinti nereikalingą kodą kartodami.  Saugumas  Šis pertvarkymas yra saugus, jei po pakeitimų kruopščiai išbandysite savo programą. Statinės analizės įrankiai gali padėti užtikrinti, kad nepašalintumėte nieko vis dar naudojamo.  Kodėl kodas geresnis?  Jūs pagerinate aiškumą ir sumažinate sudėtingumą pašalindami nenaudojamus elementus.  Jūsų kodas tampa lengviau suprantamas ir prižiūrimas.  Sumažinus spekuliacinį kodą, taip pat sutelkiamas dėmesys į esamus, faktinius reikalavimus.  Kaip tai pagerina bijekciją?  Negyvas kodas ir spekuliaciniai elementai suardo jūsų programinės įrangos ir realaus modelio   . persipynimą  Pašalinus šiuos elementus, jūsų kodas tiksliai atspindės jūsų   , todėl jis bus švaresnis ir artimesnis realybei. MAPPER  Apribojimai  Norint pašalinti negyvą kodą, reikia įsitikinti, kad jis tikrai nenaudojamas.  Šis procesas priklauso nuo statinės analizės arba išsamių kodų bazės žinių, kurios gali būti klaidos be patikimų įrankių.  Refaktorius su AI  Be tinkamų instrukcijų  Su konkrečiomis instrukcijomis   ChatGPT   ChatGPT   Klodas   Klodas   Sumišimas   Sumišimas   Antrasis pilotas   Antrasis pilotas   Dvyniai   Dvyniai  Žymos  Pučiantys  Susiję pertvarkymai   https://hackernoon.com/improving-the-code-one-line-at-a-time?embedable=true  Kreditai  Vaizdas   iš  Peter H Pixabay  Šis straipsnis yra „Refaktoring“ serijos dalis.   https://maximilianocontieri.com/how-to-improve-your-code-with-easy-refactorings?embedable=true

The code in this story is for educational purposes. The readers are solely responsible for whatever they build with it.

Winner of Noonies 2020 for the award Hacker Noon Contributor of the Year - REFACTORING.

Refaktoringas 021 – pašalinkite neveikiantį kodą

About Author

KOMENTARAI

PABAIGTI ŽYMES

ŠIS STRAIPSNIS BUVO PRISTATYMAS

Related Stories

Light-Mode

Classic

Newspaper

Dark-Mode

Neon Noir

Minty

HN StartUps