# code style Published articles for code style. This is one page of public article previews, not the complete archive. Follow Next page to continue. Summaries are not the original full articles. ## Зачем CI/CD тестировщикам? DevFeed: [Зачем CI/CD тестировщикам?]() Original publisher: [Read original article]() Author: alexpshe (JetBrains) Published: 2022-02-10T11:18:13Z Content type: tutorial Language: ru Sources: [JetBrains RU]() Topics: [CI/CD](), [ci](), [Code]() Tags: [ci](), [ci-cd](), [code](), [code-style](), [qa](), [quality](), [quality-control](), [qualitygates](), [tag-9ec75300b635](), [tag-e932065bc8da](), [testops]() ### AI overview This article explains why CI/CD is useful to QA engineers and TestOps. It discusses automatic test execution and quality gates that prevent features from reaching product code until required checks pass, including builds, code style, and static analysis. ### Source excerpt Сейчас компетентность в сфере TestOps является таким же базовым требованием к QA-инженерам, как и написание автоматизированных тестов. Причина -- в активном развитии CI/CD в проектах и необходимости QA-инженерам работать с пайплайнами (читать как "последовательность этапов в CI/CD") и даже внедрять свои. Так почему же CI/CD -- отличный инструмент контроля качества? Давайте разбираться. Читать далее ## An opinionated guide on how to make your Kotlin code fun to read and joy to work with DevFeed: [An opinionated guide on how to make your Kotlin code fun to read and joy to work with]() Original publisher: [Read original article]() Author: Gabor Varadi Published: 2021-02-15T06:16:05Z Content type: tutorial Language: en Sources: [Stories by Gabor Varadi on Medium]() Topics: [Kotlin](), [Code]() Tags: [android](), [android-app-development](), [androiddev](), [code](), [code-style](), [guide](), [how-to](), [kotlin](), [maintainability](), [readability]() ### AI overview An opinionated guide to writing Kotlin code that is easier to read and maintain. It recommends formatting multi-argument constructors across lines, using let mainly in assignments or return statements, avoiding it for general control flow or side effects, and replacing implicit lambda arguments with meaningful names in complex expressions. ### Source excerpt I've been meaning to write this article in a while. Hopefully, the following tips and style recommendations (in no particular order) will help you write better Kotlin! Let's get on with it, shall we? For 2 or more constructor arguments, prefer not to keep the properties on the same line as the class name in the constructor definitionclass MyClass( val a: A, val b: B, ): MyParentClass(a, b), MyInterface { // ... } This format is preferable, because when adding the 3rd argument, important bits (such as a possible base class or interface) can appear too far on the right side of the screen. Listing them one after the other (including the trailing comma since 1.4.21+) allows for better readability and extensibility (reducing the chance of causing merge conflicts with future code changes, for example). Prefer to use the scoping function 'let' only in assignments or return statements, but NOT as general control flow, or a "quick rename to 'it'" Oftentimes, Kotlin code tends to do something like this: fun myMethod(nullableA: A?) { nullableA?.let { // no it.x() // no it.y() // no it.z() // no } } (Note: in a method like this, A? could be replaced with A to take advantage of typed nullability, this is just an example.) To allow better maintainability and readability, we should instead prefer to only use ?.let { in simple assignments, or return statements, but not as general control flow. For example, the following chain is easy to understand: val protoClass = savedInstanceState?.getByteArray("protoValue") ?.let { ProtoClass.parseFrom(it) } However, in this case, ?.let { is part of an assignment. Also, while ?.let { can be chained with a ?: to provide a default value (especially in combination with takeIf) it shouldn't be used to execute side-effects (also is more suitable for that). In fact, it needs to be said: x?.let {} ?: run {} is NOT a general purpose replacement for if-else statements and null-checks, and should never be used in this particular format for that purpose! ## Kotlin Code Review: Avoiding Unproductive Nitpicking Over Concise and Idiomatic Code DevFeed: [Kotlin Code Review: Avoiding Unproductive Nitpicking Over Concise and Idiomatic Code]() Original publisher: [Read original article]() Published: 2020-10-14T00:00:00Z Content type: tutorial Language: en Sources: [Vasya Drobushkov]() Topics: [Code review](), [Kotlin](), [code style](), [Development]() Tags: [code-review](), [code-style](), [development-process](), [kotlin](), [quality]() ### AI overview This article examines how code review can become unproductive when reviewers focus excessively on style, concision, or idiomatic Kotlin patterns. It discusses the trade-offs behind some Kotlin constructs and argues that shorter code is not automatically better. ### Source excerpt Introduction Code review is an essential tool for a development team, which helps ensure high-quality standards of code. While reviewing others' code one might find bugs, design issues, and so on. One another part of reviewing is getting used to the codebase and following team's code style for better maintenance. Though it is pretty cool in theory, in practice team might face few issues, one of which is nitpicking. When review is bloated with dozens of similar comments related to e.g. how beautifully code looks like. Common code style is important, but having a lot of similar comments in each review doesn't help. Instead of trying to understand what code is doing, nitpicker writes a lot of similar comments on the style. Back and forth discussions or fixes of such slow down development process and overall make team's morale worse. ## Design of everyday things DevFeed: [Design of everyday things]() Original publisher: [Read original article]() Author: Ruslan Cheremin (noreply@blogger.com) Published: 2020-07-19T19:13:00Z Content type: opinion Language: ru Sources: [\>рабочие заметки]() Topics: [User Experience](), [API](), [Back end](), [Code]() Tags: [api](), [backend](), [code](), [code-style](), [tag-2c039dce53be](), [tag-8b0adca51b34](), [user-experience]() ### AI overview The author reviews Donald Norman's book The Design of Everyday Things and argues that its principles of user experience and interface design apply directly to backend software and APIs. A checklist for designing physical devices is reframed for application programmers working with APIs. ### Source excerpt Недавно прочитал "Дизайн привычных вещей" Дональда Нормана. Норман - computer scientist, и когнитивный психолог, известный и авторитетный специалист по эргономике. Он популяризовал сам термин "user experience", и был, вероятно, первым User Experience Architect - в Apple, что совершенно не удивляет. На его книгу я наткнулся совершенно случайно, и залип с первых страниц. Книга ## Enforcing Consistent Coding Conventions with Shared IDE Settings and Build Checks DevFeed: [Enforcing Consistent Coding Conventions with Shared IDE Settings and Build Checks]() Original publisher: [Read original article]() Published: 2019-06-27T00:00:00Z Content type: tutorial Language: en Sources: [Paweł Chudzik]() Topics: [coding](), [configuration](), [ide](), [version-control](), [Maven](), [Gradle](), [IntelliJ IDEA](), [Vim]() Tags: [code-style](), [coding](), [configuration](), [git](), [gradle](), [ide](), [maven](), [version-control](), [vim]() ### AI overview The article recommends exporting shared IDE code-style settings into version control and using build-time checks to enforce coding conventions across tools and team members. ### Source excerpt When the whole team agrees on coding standards we tend to be optimistic. We think that from now on everything will be exactly as we decided. The truth is that usually after a couple of months you'll reinstall IDE or system and forget about configuration or new people join and it's the Wild West all over again. Read more ## Empire Node 2016 DevFeed: [Empire Node 2016]() Original publisher: [Read original article]() Author: Jack Tarantino Published: 2016-11-08T22:57:34Z Content type: article Language: en Sources: [Jacopo Tarantino]() Topics: [code style](), [ESLint](), [React](), [Redux](), [MongoDB](), [Promise](), [CommonJS](), [middleware]() Tags: [callback](), [code](), [code-style](), [commonjs](), [empire-node](), [eslint](), [javascript](), [modules](), [mongodb](), [new-york-city](), [node-js](), [react](), [redux]() ### AI overview Notes from Empire Node 2016 cover talks about HyperTerm and its React and Redux plugin architecture, ESLint rules and coding practices, and MongoDB, along with other programming topics. ### Source excerpt Yesterday I had the good fortune to attend Empire Node at The National Museum of the American Indian, courtesy of InRhythm. A good time was had by all and we got to see some great talks! There was programmable music, smart ways to get into code style linting and, of ## Clarity Conf Day 1 Notes DevFeed: [Clarity Conf Day 1 Notes]() Original publisher: [Read original article]() Author: Jack Tarantino Published: 2016-04-01T17:28:56Z Content type: article Language: en Sources: [Jacopo Tarantino]() Topics: [Design system](), [Frameworks](), [Material Design]() Tags: [best-practices](), [clarity-conf](), [code-style](), [design](), [design-systems](), [front-end](), [guides](), [style-guide](), [styleguide-driven-development]() ### AI overview Notes from the first day of Clarity Conf covering style guides, design systems, pattern libraries, responsive design, and the practical reasons organizations adopt more consistent interfaces and workflows. ### Source excerpt Here are my notes from day 1 of Clarity Conf. Apologies in advance to the speakers whom I am certain I misquoted and misrepresented. Also if I missed things. Also for having some personal stuff just in the middle of there. Also because there's probably like 90 typos. I may ## How Code Reviews Support Chromium's Code Quality and Team Resilience DevFeed: [How Code Reviews Support Chromium's Code Quality and Team Resilience]() Original publisher: [Read original article]() Author: Monica Dinculescu Published: 2014-03-31T00:00:00Z Content type: opinion Language: en Sources: [Monica Dinculescu]() Topics: [Code](), [Chromium](), [code style](), [bus factor]() Tags: [bus-factor](), [chromium](), [code](), [code-reviews](), [code-style]() ### AI overview The article explains how Chromium uses code reviews and style guides to manage a large, actively changing codebase. It argues that review helps catch broken or poor-quality code, maintain consistency, and reduce reliance on a small number of contributors. ### Source excerpt Stats: a preamble I've been reading too much about March Madness brackets, so I thought I had to run some numbers around here like the cool kids do. Get your umbrella out, it's about to rain cold facts. In the history of time, Chromium has had 205,095 commits made by 1,943 contributors representing 7,431,088 lines of code. In the last 30 days, there have been 5021 commits, by 637 contributors, including 53 new hoomans. I did some advanced Nate Silver analysis here for you, and that's at least 167 commits and 1+ new committers a day. On average, that's at least 7 commits an hour. Every hour. All of the hours. That's an imperial ton of new code being added, by what it seems like new people. Imagine if everyone could commit code willy-nilly. Are you imagining a minefield? You should. Code reviews ftw Good news for our browser using audience! Chromium isn't a minefield, and on top of it, has pretty awesome looking code. This comes from the fact that any code changes need to be reviewed and blessed before they can land on the master branch. More eyes means less bugs means you're less likely to commit broken code and break the internet. And you really don't want to break the internet. Even if you have tests, and everything is going your way, you can write correct, but genuinely shitty code. 7 million lines of kinda-shitty code is not something anyone wants to work with, and are worth investing a little time in fixing. Code reviews also bring up the bus factor, which is my favourite sinister nerd metaphor. You know, the buuuuuus factor. The number of people that can get run over by a bus on a team before that team is royally and epically screwed. If all the code that you write has been closely read by a different person, then you're probably ok getting run over by a bus every once in a while. But still, you probably shouldn't. Who would feed your cat? Consistent code is the best code Code style guides are sooper neat, and are a huge part of code reviews, because ain't nobo ## C++ Practices from Chromium Code Style: Avoiding Copies and Using Debug Checks DevFeed: [C++ Practices from Chromium Code Style: Avoiding Copies and Using Debug Checks]() Original publisher: [Read original article]() Author: Monica Dinculescu Published: 2014-01-20T00:00:00Z Content type: tutorial Language: en Sources: [Monica Dinculescu]() Topics: [C++](), [Chromium](), [code style](), [Compiler](), [debug](), [test-coverage]() Tags: [c-plus-plus](), [chromium](), [clang](), [code-style](), [compiler](), [debug](), [test-coverage]() ### AI overview A practical C++ article based on Chromium code style. It discusses preventing unwanted copy construction and assignment with a macro, and using debug-only checks to catch bad scenarios during development and testing. ### Source excerpt Disclaimer: these aren't new protipz. I didn't make them up. They're actually straight out of the Chromium code style, they're pretty trivial, and you might already use them. But just in case you're not a Chromium committer (the outrage), or are fairly new at C++ and want to make your code less suck, here they are. I think they're neat. Copy constructors and their brethren You know that scene from The Fly when Jeff Goldblum, having not screwed up teleporting a small baboon, decides he should totally teleport himself? But then he screws that up (because software), manages to turn himself into a giant terrifying fly (because David Cronenberg), and continues to give me nightmares as an adult. That's exactly how I feel about copy constructors. You can absolutely get them right, but they're a pain, and among other crimes they're committing, they're sometimes deceivingly slow. The point is, most of the time you don't even need them. I mean, Jeff Goldblum teleported himself like three meters away. Couldn't he have just walked? What we tend to do instead is convince the compiler to get annoyed with us if we try to use a copy constructor. This is easy because the compiler <3s being annoyed with us. So we can define a nice macro (stay with me) that adds a private declaration, but doesn't implement it: #define DISALLOW_COPY_AND_ASSIGN(TypeName) \ TypeName(const TypeName&); \ void operator=(const TypeName&) Which you would then use in your private section of your class, like so: class Hooman { public: Hooman(); ~Hooman(); private: DISALLOW_COPY_AND_ASSIGN(Hooman); }; Now, when you try to be ambitious and clone Jeff Goldblum, Hooman jeffGoldblum; Hooman teleportedJeffGoldblum(jeffGoldblum); Clang will tell you something like "error: calling a private constructor of class 'Hooman'". Other compilers might tell you other things, but they'll generally have the same annoyed tone. Now would be a good time to apologize to your compiler for all the silly things you've done in the past. ## October 2013 Meeting Minutes DevFeed: [October 2013 Meeting Minutes]() Original publisher: [Read original article]() Published: 2013-11-14T00:00:00Z Content type: news Language: en Sources: [Front Page on ReactOS Website]() Topics: [ReactOS](), [Development](), [code style]() Tags: [code-style](), [development](), [free](), [open-source](), [os](), [react](), [reactos](), [win32](), [winapi]() ### AI overview Minutes from the ReactOS project's October 31, 2013 meeting cover team coordination, adoption of a coding style guideline, and the availability of foundation funds for development hardware. ### Source excerpt 2013-10-31 19:00 UTC dev.reactos.org, #meeting Proceedings Meeting started at 19:08 by Aleksey Bragin. Point 1: CoordinationPoint 2: Code Style GuidelinesPoint 3: Donations and HardwarePoint 1Aleksey Bragin opened up the meeting with a statement that the project's members need to coordinate and work better together to avoid internal confusion as to what work is being done and what work requires some help due to other commitments by team members. Point 2Colin Finck presented for approval a finalized draft for the project's coding style guideline. ## Tip for 1-click indentation settings changes in Visual Studio DevFeed: [Tip for 1-click indentation settings changes in Visual Studio]() Original publisher: [Read original article]() Author: Andrew Khmylov Published: 2011-02-27T00:00:00Z Content type: tutorial Language: en Sources: [Despite the odds]() Topics: [Visual Studio](), [code style](), [Automation](), [ide](), [C#]() Tags: [automation](), [change](), [code](), [code-style](), [csharp](), [ide](), [macros](), [spaces](), [style](), [visual-studio]() ### AI overview A tutorial explains how to create a Visual Studio macro that toggles the C# indentation setting between tabs and spaces. It uses the DTE TextEditor CSharp InsertTabs property and provides keyboard-accessible macro commands. ### Source excerpt I work at several projects at a time, and I have different settings/requirements concerning the code style for each of them. The main issue is 'Tabs vs. Spaces' option - the first project requires using tabs, the second - spaces. It's obvious that going Tools -> Settings -> ... is not an option for everyday use. Sounds like a good task for the automation macros, right? Navigate to Tools -> Macros -> Macros IDE (or use Alt+F11) Create new macros in Project Explorer (Project - Add Module) Write a method that changes the indentation settings: Public Module TabsModule Public Sub ToggleTabs() Dim currentSetting As Boolean = DTE.Properties("TextEditor", "CSharp").Item("InsertTabs").Value DTE.Properties("TextEditor", "CSharp").Item("InsertTabs").Value = Not currentSetting End Sub End Module Now you can use Macros Explorer (Alt+F8, also you can dock it as one of your panels) to quickly change settings (by double-clicking on the corresponding item name in the macros tree)