Qoder CN Series:Melhores práticas para o aprimoramento do autocompletamento de código corporativo

Diretrizes para selecionar e preparar repositórios de código

As seções a seguir descrevem como preparar repositórios de código em dois cenários diferentes:

• Cenário 1: Desenvolvimento diário de engenharia — melhore a eficiência de P&D. No desenvolvimento corporativo, utilize múltiplos repositórios de código para dar suporte à ampliação da recuperação, o que melhora a reutilização de código e a eficiência do desenvolvimento. Veja a seguir as principais formas de selecionar repositórios de código:

• Cenário 2: Cenários de negócio específicos — garanta a consistência do código e reduza o desenvolvimento repetido. No desenvolvimento de aplicações corporativas, algumas lógicas de negócio devem se manter consistentes para garantir a estabilidade e a manutenibilidade do sistema. Sem padrões unificados, diferentes desenvolvedores podem adotar implementações diferentes. Isso leva a lógica de negócio inconsistente, manutenção de código mais complexa e potenciais problemas de estabilidade do sistema.

/**
 * Use the enterprise-developed distributed lock framework for concurrency control
 */
@Service
public class InventoryService {

    @Autowired
    private DistributedLockFramework lockFramework;

    @Autowired
    private InventoryRepository inventoryRepository;

    /**
     * Deduct inventory. Use a distributed lock to ensure concurrency safety.
     * @param productId The product ID.
     * @param quantity The quantity to deduct.
     * @return Whether the deduction is successful.
     */
    public boolean deductInventory(Long productId, int quantity) {
        String lockKey = "inventory:" + productId;
        return lockFramework.withLock(lockKey, 30, TimeUnit.SECONDS, () -> {
            Inventory inventory = inventoryRepository.findByProductId(productId);
            if (inventory == null || inventory.getQuantity() < quantity) {
                return false;
            }
            inventory.setQuantity(inventory.getQuantity() - quantity);
            inventoryRepository.save(inventory);
            return true;
        });
    }
}

/**
 * Recommendation engine service
 * Implements a personalized recommendation mechanism based on user behavior and commodity features
 */
@Service
public class RecommendationService {

    @Autowired
    private UserBehaviorRepository userBehaviorRepo;

    @Autowired
    private ProductRepository productRepo;

    /**
     * Generate a personalized recommendation list for a specified user
     * @param userId The user ID.
     * @param limit The number of recommendations.
     * @return The list of recommended commodity IDs.
     */
    public List<Long> generateRecommendations(Long userId, int limit) {
        // Obtain user behavior data
        List<UserBehavior> behaviors = userBehaviorRepo.findRecentByUserId(userId, 100);

        // Extract user interest features
        Map<String, Double> userInterests = extractUserInterests(behaviors);

        // Obtain the candidate commodity pool
        List<Product> candidateProducts = productRepo.findRecentlyActive(1000);

        // Score and rank commodities
        List<ScoredProduct> scoredProducts = candidateProducts.stream()
            .map(product -> new ScoredProduct(product, calculateScore(product, userInterests)))
            .sorted(Comparator.comparing(ScoredProduct::getScore).reversed())
            .collect(Collectors.toList());

        // Return the highest-scoring commodities
        return scoredProducts.stream()
            .limit(limit)
            .map(sp -> sp.getProduct().getId())
            .collect(Collectors.toList());
    }

    // Other auxiliary methods...
}

Especificações de arquivo de código

• Linguagens e frameworks suportados:

  • Backend: Java, C#, C/C++, Go, Python.

  • Frontend: JavaScript, TypeScript, Vue, React.

• Limites de upload: O sistema aceita somente arquivos de código-fonte. O repositório de código deve conter somente os arquivos de código-fonte que você realmente escreveu. Por exemplo, carregue arquivos .java para Java, arquivos .cs para C# e arquivos .js ou .jsx para JavaScript.

• Evite carregar o seguinte conteúdo:

  • Dados e código de teste: Não carregue scripts de teste, casos de teste ou qualquer código relacionado a teste que não contenha lógica de negócio.

  • Métodos mock: Exclua todo o código gerado por métodos e ferramentas de mock, a menos que o código contenha implementações específicas de lógica de negócio.

  • Artefatos de build:

    • Frontend: Exclua arquivos gerados por ferramentas de build como Webpack e Gulp. Esses arquivos geralmente estão localizados no diretório dist ou build.

    • Backend: Exclua arquivos DLL compilados e todas as outras saídas de compilação.

• Requisitos de comentários:

  • Adicione comentários detalhados no cabeçalho de cada função que deseja recuperar.

  • Os comentários devem fornecer informações suficientes para distinguir funções diferentes. Consulte um modelo de comentário ou ajuste os comentários de acordo com as especificações da sua empresa.

/**
 * Update the status of a specified order.
 *
 * @param orderId The unique identifier of the order.
 * @param newStatus The new order status.
 * @return boolean Indicates whether the update is successful.
 */

• Requisitos de nomenclatura de funções:

  • Se os comentários da função forem breves, o nome da função deve descrever com precisão a sua funcionalidade.

  • Utilize nomes claros e descritivos, como exportOrdersToPDF e updateOrderStatus, em vez de func1.

Diretrizes de upload

• Arquivos compactados: Empacote os arquivos de código no formato .zip, .gz ou .tar.gz.

• Limite de tamanho do pacote de código: Cada pacote de código não deve exceder 100 MB.

Melhores práticas de backend

Gere código a partir de comentários em linguagem natural

• Carregue código no repositório de código corporativo: Carregue um pacote compactado que contenha o código de função necessário no repositório de código corporativo, por exemplo o código do algoritmo Snowflake. Certifique-se de que a função alvo siga a especificação de comentários com os comentários posicionados no cabeçalho da função. Para obter mais informações sobre como preparar o repositório de código, consulte How administrators prepare a high-quality enterprise code repository.

/**
 * Use the Snowflake algorithm to generate a unique serial number
 * @param workerId
 * @return
*/
public synchronized Long getSnowFlowerId(long workerId){
 long id = -1L;

 if (workerId < 0 || workerId > snowFlowerProperties.getMaxWorkerId()) {
    throw new IllegalArgumentException(
      String.valueOf("workerID must gte 0 and lte " + snowFlowerProperties.getMaxWorkerId()));
 }

 // ... algorithm implementation code ...

return id;
}

• Insira comentários: No IDE, localize uma classe Java e insira um comentário que corresponda à função que você deseja recuperar. O formato do comentário pode ser flexível, mas certifique-se de que o significado seja preciso e consistente.

//Please generate code that uses the Snowflake algorithm to generate a unique ID and returns the generated ID

/**
 * Use the Snowflake algorithm to generate a unique serial number
 * @param wId
 * @return
*/

Requisitos de comentários:

• Comprimento do comentário: Evite comentários excessivamente curtos ao escrever código. Utilize pelo menos 15 caracteres. Comentários muito curtos não conseguem acionar a recuperação.

• Semântica do comentário: Certifique-se de que a semântica dos comentários seja precisa e significativa. Inclua palavras-chave e descrições de valor de retorno sempre que possível, para que o Qoder CN possa compreender e corresponder com precisão ao código adequado.

• Suporte a múltiplos idiomas: Há suporte para comentários em chinês e inglês. Os comentários no repositório de código e os comentários usados durante a codificação real podem estar em idiomas diferentes.

• Flexibilidade do nome do parâmetro: Você pode tratar os nomes dos parâmetros com flexibilidade. O Qoder CN ajusta automaticamente os parâmetros fornecidos para corresponder ao código recuperado. A seguir estão exemplos negativos:

  • //Snowflake algorithm — Problema: Não são fornecidas informações suficientes e o comentário é muito curto.

  • //Generate a unique serial number — Problema: Nenhuma palavra-chave específica é utilizada, o que pode afetar a compreensão e a correspondência.

• Geração de código: Após pressionar Enter pela primeira vez, o Qoder CN fornece uma sugestão de autocompletamento gerada a partir do comentário. Ao pressionar Enter novamente, o Qoder CN completa o código com base no código do repositório de código corporativo.

/**
 * Use the Snowflake algorithm to generate a unique serial number
 * @param workerId
 * @return
 */
public synchronized Long get(long workerId) {
    long id = -1L;
    if (workerId < 0 || workerId > snowFlowerProperties.getMaxWorkerId()) {
        throw new IllegalArgumentException(
                String.valueOf("workerID must gte 0 and lte " + snowFlowerProperties.getMaxWorkerId()));
    }
    long timestamp = timeGen();
    if (timestamp < lastTimestamp) {
        long refusedSeconds = (lastTimestamp - timestamp) / 1000;
        throw new RuntimeException(
                String.valueOf("Clock moved backwards. Refusing for " + refusedSeconds + " seconds"));
    }
    if (lastTimestamp == timestamp) {
        // Within the same millisecond, the sequence number is incremented
        sequence = (sequence + 1) & snowFlowerProperties.getSequenceMask();
        if (sequence == 0) {
            // The maximum number of sequence numbers in the same millisecond has been reached
            timestamp = tilNextMillis(lastTimestamp);
        }
    } else {
        // In different milliseconds, the sequence number is set to 0
        sequence = 0L;
    }
    lastTimestamp = timestamp;
    // Timestamp part
    id = (timestamp - snowFlowerProperties.getTwepoch()) << snowFlowerProperties.getTimestampLeftShift();
    // Worker identifier part
    id |= (workerId << snowFlowerProperties.getWorkerIdShift());
    // Sequence number part
    id |= sequence;
    return id;
}

• Se o seu comentário contiver parâmetros, o Qoder CN ajusta automaticamente os parâmetros no código gerado para garantir a consistência de nomenclatura.

• Para atualizar o cache e obter novas sugestões de autocompletamento, pressione ⌥(option) + P no macOS ou Alt + P no Windows para acionar manualmente o autocompletamento de código inline.

Gere código a partir de assinaturas de função

• Envie código ao repositório de código corporativo: Envie um pacote compactado que contenha o código de função necessário ao repositório de código corporativo. Certifique-se de que essas funções possuam identificadores claros e exclusivos para recuperação e reconhecimento. Para obter mais informações sobre como preparar o repositório de código, consulte How administrators prepare a high-quality enterprise code repository.

• Insira assinaturas de função: No IDE, localize uma classe Java e insira a assinatura da função alvo. Você pode tratar os nomes dos parâmetros com flexibilidade. O Qoder CN ajusta automaticamente os parâmetros fornecidos para corresponder ao código recuperado.

public List<Object> nextList(String name, int size)

Requisitos de assinatura de função:

• Nome da função: Utilize um nome de função claro com semântica suficiente para servir de base para a correspondência por similaridade.

• Parâmetros e valores de retorno: Os tipos e a ordem devem corresponder à função alvo, mas você pode tratar os nomes dos parâmetros com flexibilidade. O Qoder CN ajusta automaticamente os parâmetros fornecidos para corresponder ao código recuperado. A seguir estão exemplos negativos:

  • public List<Object> func1(String name, int size) — Problema: O nome da função possui semântica pouco clara e não consegue refletir com precisão a funcionalidade.

  • public List<String> nextList(int orderId) — Problema: Os tipos de parâmetro e o tipo de valor de retorno não correspondem à função alvo.

• Sugestão de autocompletamento: Após pressionar Enter pela primeira vez, o Qoder CN fornece uma sugestão de autocompletamento de código. Ao pressionar Enter novamente, o Qoder CN completa automaticamente o código com base no código do repositório de código corporativo.

• O Qoder CN ajusta automaticamente os nomes dos parâmetros no código gerado com base nos nomes de parâmetros que você fornece, para garantir a consistência de nomenclatura.

• Para atualizar o cache e receber novas sugestões de autocompletamento, pressione ⌥(option) + P no macOS ou Alt + P no Windows para acionar manualmente o autocompletamento de código inline.

Melhores práticas de frontend

Complete o código de componentes personalizados frontend a partir de tags

• Faça upload de código para o repositório de código corporativo: Antes de começar, certifique-se de que todo o código de componente frontend necessário foi carregado no repositório de código corporativo. O exemplo a seguir utiliza o framework React:

<LTable
      isReady={isReady}
      formInitialValues={formInitialValues}
      rowKey="key"
      tableRef={tableRef}
      toolbarLeft={
          <Button type="primary">Add</Button>
      }
      formItems={formItems}
      formRef={formRef}
      columns={columns}
      request={async (params, requestType) => {
        const res: Record<string, any> = await apiGetUserList(params);
        return {
          data: res.data,
          total: res.total,
        };
      }}
/>

• Escreva o código do componente: Abra o arquivo .jsx correspondente no seu IDE e comece a escrever o código. Insira uma tag HTML básica ou uma tag de componente personalizado, como <LTable />.

• Autocompletamento de código: Quando o código inserido atinge um determinado comprimento e corresponde ao código na biblioteca de componentes corporativa, o IDE aciona automaticamente o autocompletamento de código e gera o código completo do componente. Pressione Enter também para acionar o autocompletamento de código manualmente.

Acione o autocompletamento dentro de uma tag de componente completa.

Gere código a partir de comentários em linguagem natural

• Carregue código no repositório de código corporativo: Carregue um pacote compactado que contenha o código de função necessário no repositório de código corporativo. Certifique-se de que cada função siga a especificação de comentários com os comentários posicionados no cabeçalho da função. Para obter mais informações sobre como preparar o repositório de código, consulte How administrators prepare a high-quality enterprise code repository. O exemplo a seguir utiliza JavaScript:

/**
 * Generate an object keyed by id based on error messages
 * @param {Array<validator,Result>} results
 * @return {Record<string,string>}
*/
function getErrObj(results) {
  // ... function implementation code ...
}

• Insira comentários: No IDE, insira o conteúdo de comentário específico em um arquivo JavaScript, conforme mostrado no exemplo a seguir:

//Generate an object keyed by id based on error messages

Requisitos de comentários:

• Comprimento do comentário: Evite comentários excessivamente curtos ao escrever código. Utilize pelo menos 15 caracteres. Comentários muito curtos não conseguem acionar a recuperação.

• Semântica do comentário: Certifique-se de que a semântica dos comentários seja precisa e significativa. Inclua palavras-chave e descrições de valor de retorno sempre que possível, para que o Qoder CN possa compreender e corresponder com precisão ao código adequado.

• Suporte a múltiplos idiomas: Há suporte para comentários em chinês e inglês. Os comentários no repositório de código e os comentários usados durante a codificação real podem estar em idiomas diferentes.

• Flexibilidade do nome do parâmetro: Você pode tratar os nomes dos parâmetros com flexibilidade. O Qoder CN ajusta automaticamente os parâmetros fornecidos para corresponder ao código recuperado.

• Geração de código: Após pressionar Enter pela primeira vez, o Qoder CN fornece uma sugestão de autocompletamento gerada a partir do comentário. Ao pressionar Enter novamente, o Qoder CN completa o código com base no código do repositório de código corporativo.

//Generate an object keyed by id based on error messages
export function getErrObj(results) {
    if (!results || results.length <= 0) return {};

    const obj = {};
    for (let i = 0; i < results.length; i++) {
        const result = results[i];
        if (result.ok === false) {
            obj[result.id] = result.msg || '';
        }
    }
    return obj;
}

• Se o seu comentário contiver parâmetros, o Qoder CN ajusta automaticamente os nomes dos parâmetros no código gerado para garantir a consistência de nomenclatura.

• Para atualizar o cache e obter novas sugestões de autocompletamento, pressione ⌥(option) + P no macOS ou Alt + P no Windows para acionar manualmente o autocompletamento de código inline.

Perguntas frequentes

Após a reinstalação, você ainda não consegue recuperar o código na base de conhecimento, mesmo após reiniciar o IDE ou fazer login novamente.

Solução:

• No macOS, execute o comando a seguir para reiniciar o processo e limpar o cache:

  ps -ef|grep lingma|grep start|awk '{print $2}'|xargs -I {} kill -9 {}

• No Windows, finalize o processo do Qoder CN no Task Manager.