Giter Club home page Giter Club logo

Comments (4)

bluebore avatar bluebore commented on May 30, 2024

这个真心比较难,慢慢来吧~

from tera.

00k avatar 00k commented on May 30, 2024

如果注释是用来描述代码的,那规范的代码本身比注释更容易被程序员理解
如果注释是用来描述设计的,那么还是用文档的形式表现出来会更好,毕竟会更集中、更抽象
所以我认为有两个地方需要注释,一是算法非常复杂,看代码不容易理解;二是对API的描述
其他情况下注释都可以用代码或文档取代
头文件中大段的注释可能只是把文档写在了代码中
你觉得呢

from tera.

BabySid avatar BabySid commented on May 30, 2024

可以接受。系统设计一般不放在代码中。单独列出比较合适。
对于代码中的注释,更多于接口功能说明。(.h)
对于实现的注释,可以是较复杂逻辑的背景原因解释。(
.cpp)

from tera.

00k avatar 00k commented on May 30, 2024

好的,后面我们会按照这个原则进行开发

from tera.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.