• Inicio
  • Novedades
  • Academia SAP
  • FAQ
  • Blog
  • Contacto
S4PCADEMY_Logo
  • Inicio
  • Novedades
  • Academia SAP
  • FAQ
  • Blog
  • Contacto
Twitter Linkedin Instagram

S4PCADEMY_Logo
  • Inicio
  • Novedades
  • Academia SAP
  • FAQ
  • Blog
  • Contacto
Twitter Linkedin Instagram
ABAP Clean Code  ·  adaptability  ·  cleancode  ·  evolvability  ·  maintainability  ·  maintainance  ·  Technical Articles  ·  Testautomation

Código limpio: escrevendo código sustentável, legível e testável

By s4pcademy 


Clean code é um termo usado para descrever software que é fácil de ler, entender, manter e testar. Neste blog, quero resumir algunos principios importantes y fornecer uma introdução ao topicas para iniciantes. Além disso, o blog deve se conecta ao repositório de guias de estilo, aos livros e às iniciativas atuais em que os especialistas pueden contribuir.

O que torna o codigo limpo?

A obtenção do código limpo envolve seguir um conjunto de mejores prácticas y padrões, como usar nombres significativos, manter as funções pequenas e focadas e usar comementários com moderação. Ter uma base de código, legível e sustentável, é essencial para o desenvolvimento sustentável. Os livros Clean Code de Robert C. Martin, Code Complete de Steve McConnell, The Pragmatic Programmer de David Thomas/Andy Hunt, y algunos outros livros contêm muitas melhores práticas e exemplos de código limpo.

O que é código que não está limpo?

Código que não é limpo é um código que é difícil de ler, entender e manter. Pode ter má organização, nomes confusos ou enganosos, estilo inconsistente e outros problemas que dificultan o trabalho.

Algunos ejemplos de código que no está limpio pueden incluir:

  • Código con funciones largas y complejas de difícil comprensión, prueba y manutención.
  • Código com convenções de nomes ruins, como variáveis ​​com nomes curtos, não descritivos ou funções com nomes que não refletem com precisão sua finalidade.
  • Código con estilo inconsistente, como indentação ou espaçamento inconsistentes, o que puede dificultar a leitura ea compreensão.
  • Código com código desnecessário ou redundante, o que puede dificultar a manutenção ea compreensão.
  • Código que torna difícil a automação de testes, por ejemplo, acoplamento (coupling) estático entre clases.

No geral, o código que não é limpo é muitas vezes mais probable a erros e bugs, e pode ser mais demorado para trabalhar, pois requer mais esforço para entender, testar e manter.

Código%20Calidad%20de%20xkcd.com/1513/%20under%A0Creative%20Commons%20BY-ND%202.5

Calidad de código de xkcd.com/1513/ em Creative Commons BY-ND 2.5

Beneficios del código limpo

Existen muchos beneficios para escrever o código limpo, incluyendo:

  • Mejor legibilidade e comprensión: limpar o código é mais fácil de ler e entender, o que puede facilitar a adaptação, debug e manutenção dos desenvolvedores.
  • Risco reduzido de erros e bugs: Código limpo geralmente é mais confiável e menos probable a erros e bugs, pois é mais fácil de entender, testar e manter.
  • Mayor productividad: é mais fácil y rápido trabalhar com código limpo, o que puede aumentar a produtividade ea eficiência do desenvolvedor. De acuerdo con un meta-estudioo código não saudável pode conter mais de 15 vezes mais defeitos e reduzir a produtividade por um fator de 9.
  • Mayor capacidad de adaptación y evolución: código modular limpo é más fácil de modificar y actualizar, o que puede ajustar o software a evoluir y se adapta a los requisitos mudanças ao longo do tempo.
  • Melhor colaboração em equipe: a limpeza do code é mais fácil para os miembros da equipe entenderem e trabalharem, o que puede melhorar a colaboração ea comunicação dentro da equipe.
  • Melhor manutenção a longo prazo: código limpo é mais fácil de mantener y actualizar ao longo do tempo, o que puede economizar tempo e recursos. E reduzir o risco se os engenheiros se deslocarem para outros projetos ou deixarem a empresa.
  • Aumento de la reutilización del código: Limpiar el código en los módulos facilita la reutilización en diferentes contextos, o puede economizar el tiempo y los recursos.
  • Melhor desempenho: o código limpo geralmente é mais eficiente e pode ser ejecutado mais rapidamente, pois é menos complexo e mais fácil de otimizar quando necessário.
  • Processo aprimorado de revisão de code: o código limpo é mais fácil de revisar, pois é mais organizado e mais fácil de entender. Isso puede leer una revisión de código más eficientes y eficaces.
  • Melhor reputação: escrever código limpo pode ajudar a aumentar a reputação do desenvolvedor ou equipe de desenvolvimento, pois demonstra um compromisso com a qualidade eo profissionalism.

Em geral, o código limpo pode ajudar a garantir que seu software seja confiável, sustentável e fácil de trabalhar, o que pode levar a maior eficiência, produtividade, maior qualidade e maior satisfação de desenvolvedores e usuários. Os benefícios do código limpo vão além do processo de desenvolvimento e podem ter um impact positive no sucesso de longo prazo do software and da equipe que trabalha nele.

Principios e ejemplos importantes de código limpo

Primeiramente, resumimos algunos principios importantes para el código de limpeza e forneçam algunos ejemplos simples. Para cada princípio há muito mais a aprender no guia de estilo e nos livros.

  • A limpeza do code torna mais fácil para os desenvolvedores entender, modificar e manter um sistema de software. Quando o código está limpo, é mais fácil encontrar e corregir errores, e é menos provável que quebre quando as alterações são feitas.
  • Um dos princípios fundamentalis do código limpo é a legibilidade, o que significa que o código deve ser fácil de entender, mesmo para alguém que não esteja se utilizan com o sistema. Para obtener isso, os desenvolvedores devem, por ejemplo, usar nombres significativos para variáveis, funções y classes.
  • Outro princípio importante do código limpo é a simplicidade, o que significa que o código deve ser o mais simples possível, sem complexidade desnecessária. Para conseguirlo, los desenvolvedores deben evitar el uso de estructuras de dados o algoritmos complejos, a menos que sejam necessários, y deben evitar adicionar funcionalidades ou funcionalidades desnecessárias.
  • Além da legibilidade e simplicidade, o código limpo também deve ser atualizável, o que significa que deve ser fácil modificar e atualizar o código sem quebrá-lo. Para obtener iso, os desenvolvedores devem escrever um código modular que é organizado en funciones pequeñas y focadas, y deve evitar una duplicación de código.
  • Finalmente, o código limpo deve ser bem documentado. Isso significa que deve incluir comentarios claros y concisos que expliquem a finalidade ea funcionalidade do code. No entanto, os commentários não devem ser used para explicar o proprio código; o código deve ser escrito de uma forma autoexplicativa.

No geral, o código limpo é uma parte esencial do desenvolvimento de software. Isso facilita a comprensão ea manutenção de um sistema y puede ayudar a evitar bugs y outros problemas.

El depósito de la guía de estilo

https://github.com/SAP/styleguides

Sob a licença CC BY 3.0 y aberta a contribuições internas y externas da SAP, esperamos que esse repositório ajude desenvolvedores em todo o mundo a tornar seu código um pouco mais limpo, dia a dia.

O objetivo de longo prazo do repositório de guias de estilo é cobrir as linguagens de programação mais importantes do world SAP. Até agora, só o ABAP está coberto, mas estou convencido de que mais está por vir. Talvez também estejamos aptos para cobrir Java, TypeScript, Kotlin, Go y muito mais – em vez de um deseo next da realitye.

libros

Existen varios libros, que abordan el tema en detalle, explican o raciocínio eo aplicam a linguagens de programação específicos.

Os livros também são muito adequados para aquellos que estão começando a aprender as linguagens de programação. Ou colegas que já dominaram o Clean ABAP y querem aprender a limpiar o SAPUI5. E até especialistas na linguagem de programação mencionaram que aprenderam muito e foi uma fonte de inspireção.

Limpiar%20Código%20Libro%20Familia%20para%20ABAP%20y%20SAPUI5%20/%20JavaScript

Limpiar la familia de libros de código para ABAP y SAPUI5/JavaScript

Uma base para melhoria

Os principais benefícios de ter uma compreensão comum de um estilo de código em uma dad linguagem de programação são a melhor mantenibilidade, legibilidade e testabilidade. Mas também há muitos outros benefícios y novas possibilidades, que este blog explora mais detalhadamente:

  • ¿Por qué ter um conjunto de regis comum? À medida que uma organização cresce, ela ajuda a manter a base de código consistente y permite que os desenvolvedores se concentren en aspectos importantes. Há menos conflitos sobre os fundamentos (por ejemplo, formato) devido a um estilo de código padrão.
  • Promoviendo o principio de otimização do código para o leitor: Dado que o código será lido com muito mais frequência do que está escrito, um princípio importante para todas las as regras é otimizar para o leitor e não para o escritor. Portanto, o guia de estilo pesa a legibilidade maior do que use expressões poderosas, o que deixa o escritor expressar algo concisamente, mas são mais tarde difíceis de ler.
  • Consistência da base de código: Se a base de código é construída com os mesmos princípios e guia de estilo em mente, ele permite que os engenheiros pulem para uma parte desconhecida do código e façam melhorias rapidamente.
  • Melhorar a experiência do desenvolvedor: ter um guia de estilo consistente cria um ecossistema por conta propria e permite melhorar a experiência do desenvolvedor. Depois que o guia de estilo foi publicado em 2019, a comunidade começou a criar ferramentas para melhorar as revisiones de código, práticas de revisão de código documentado, verificações estendidas de código estático, formatos de treinamento desenvolvidos e fez algumas ferramentas to corrigir automaticamente o code . Essa consistência criou a base for vários projetos InnerSource/open source, melhorias of platform and acionou a exploração de outras ideias.
  • Escalado de uma organización: a medida que uma organización cresce, é importante ter uma comprensión comum do estilo do código. Ele ajuda a imppulsionar novos desenvolvedores mais rapidamente y enfocar o tempo em programação de pares ou revisiones de código em outros aspectos.
  • Além disso, outras funções, não apenas desenvolvedores, beneficiam-sepor ejemplo, de consultores que precisam fazer extensões ou equipes SRE (Site Reliability Engineering) que precisam melhorar as operações.
  • A consistência também melhora a manutenção a longo prazouma vez que novos engenheiros que asumen una propiedade podem entender mais rapidamente e actualizar o código.
  • La guía de estilo permite Importar registros con verificações de código estático o até mesmo desenvolver correções automáticos. Assim, algumas discões não ocorrem mais, o que permite concentrar o tempo dos desenvolvedores em aspectos mais importantes.

Actividades actuales

Com o sucesso do guia de estilo e número de propostas de melhoria, surge a necessidade de um processo mais formal quando se trata de rever propostas de melhoria. Tornar todo o proceso transparente e ter clareza para tomar decisiones.

Isso incluye una clareza sobre cómo eles devem ser abertos, cómo são procesados ​​eo período típico no qual, de alguma forma, pode esperar uma decisão. Além disso, especialmente para mudanças com mayor impacto (por ejemplo, mudanças incompatíveis) precisamos de um processo formal para a tomado de decisão, uma vez que essas mudanças também serão refletidas em verificações estáticas de código e por isso afetam um gran número de desenvolvedores.

Nos últimos meses, trabalhamos na documentação de todo o processo e escrevemos nossos princípios norteadores para envolver a comunidade e tomar decisões. El proceso será publicado em breve.

Artigo original: https://blogs.sap.com/2022/12/21/clean-code-writing-maintainable-readable-and-testable-code/



Source link


códigoescrevendolegívellimpiosustentáveltestável

Artículos relacionados


ABSL Code  ·  access token  ·  rest api  ·  sap  ·  sap c4c  ·  Technical Articles  ·  x-www-form-urlencoded format
Generación de token de acceso a través de API REST con cuerpo de tipo formulario (x-www-form-urlencoded) usando código ABSL en SAP Cloud Application Studio
EWM-MFS  ·  mfs  ·  opensource-plc-emulator  ·  PLC  ·  Technical Articles
Sincronización de canales en emulador de PLC de código abierto
Product Information  ·  SAP HANA Cloud Migration
Migración a la nube de SAP HANA: Remediaciones de código común después de la conversión de artefactos XS Classic

Deja tu comentario Cancelar la respuesta

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *

*

*

Cómo usar la funcionalidad Mantener grupos de roles comerciales
Previo
Usando SQL para consultar su cuenta SAP BTP
Siguiente

Madrid

Calle Eloy Gonzalo, 27
Madrid, Madrid.
Código Postal 28010

México

Paseo de la Reforma 26
Colonia Juárez,  Cuauhtémoc
Ciudad de México 06600

Costa Rica

Real Cariari
Autopista General Cañas, 
San José, SJ 40104

Perú

Av. Jorge Basadre 349
San Isidro
Lima, LIM 15073

Twitter Linkedin Instagram
Copyright 2022 | All Right Reserved.
Cookies Para que este sitio funcione adecuadamente, a veces instalamos en los dispositivos de los usuarios pequeños ficheros de datos, conocidos como cookies. La mayoría de los grandes sitios web también lo hacen.
Aceptar
Cambiar ajustes
Configuración de Cookie Box
Configuración de Cookie Box

Ajustes de privacidad

Decida qué cookies quiere permitir. Puede cambiar estos ajustes en cualquier momento. Sin embargo, esto puede hacer que algunas funciones dejen de estar disponibles. Para obtener información sobre eliminar las cookies, por favor consulte la función de ayuda de su navegador. Aprenda más sobre las cookies que usamos.

Con el deslizador, puede habilitar o deshabilitar los diferentes tipos de cookies:

  • Bloquear todas
  • Essentials
  • Funcionalidad
  • Análisis
  • Publicidad

Este sitio web hará:

Este sitio web no:

  • Esencial: recuerde su configuración de permiso de cookie
  • Esencial: Permitir cookies de sesión
  • Esencial: Reúna la información que ingresa en un formulario de contacto, boletín informativo y otros formularios en todas las páginas
  • Esencial: haga un seguimiento de lo que ingresa en un carrito de compras
  • Esencial: autentica que has iniciado sesión en tu cuenta de usuario
  • Esencial: recuerda la versión de idioma que seleccionaste
  • Functionality: Remember social media settings
  • Functionality: Remember selected region and country
  • Analytics: Keep track of your visited pages and interaction taken
  • Analytics: Keep track about your location and region based on your IP number
  • Analytics: Keep track of the time spent on each page
  • Analytics: Increase the data quality of the statistics functions
  • Advertising: Tailor information and advertising to your interests based on e.g. the content you have visited before. (Currently we do not use targeting or targeting cookies.
  • Advertising: Gather personally identifiable information such as name and location
  • Recuerde sus detalles de inicio de sesión
  • Esencial: recuerde su configuración de permiso de cookie
  • Esencial: Permitir cookies de sesión
  • Esencial: Reúna la información que ingresa en un formulario de contacto, boletín informativo y otros formularios en todas las páginas
  • Esencial: haga un seguimiento de lo que ingresa en un carrito de compras
  • Esencial: autentica que has iniciado sesión en tu cuenta de usuario
  • Esencial: recuerda la versión de idioma que seleccionaste
  • Functionality: Remember social media settings
  • Functionality: Remember selected region and country
  • Analytics: Keep track of your visited pages and interaction taken
  • Analytics: Keep track about your location and region based on your IP number
  • Analytics: Keep track of the time spent on each page
  • Analytics: Increase the data quality of the statistics functions
  • Advertising: Tailor information and advertising to your interests based on e.g. the content you have visited before. (Currently we do not use targeting or targeting cookies.
  • Advertising: Gather personally identifiable information such as name and location
Guardar y cerrar